Skip to content

Commit

Permalink
Merge #2618 and doing some overdue amendments
Browse files Browse the repository at this point in the history
  • Loading branch information
drwetter committed Jan 23, 2025
1 parent 8f054c6 commit 90f1e59
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,21 @@ Contributing / participating is always welcome!

Please note the following:

* Please read at least the [coding convention](https://github.com/testssl/testssl.sh/blob/3.2/Coding_Convention.md).
* One pull request per feature or bug fix or improvement. Please do not mix issues.
* Document your pull request, both in the pull request and/or commit message and in the code.
* Please read the [coding convention](https://github.com/testssl/testssl.sh/blob/3.2/Coding_Convention.md).
* If you have something new and/or bigger which you like to contribute, better open an issue first before you get frustrated.
* Please one pull request per feature or bug fix or improvement. Please do not mix issues.
* Documention pays off in the long run. So please your document your code and the pull request and/or commit message.

Check failure on line 11 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Check for spelling errors

Documention ==> Documentation

Check failure on line 11 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Check for spelling errors

Documention ==> Documentation
* Please test your changes thoroughly as reliability is important for this project. You may want to check different servers with different settings.
* GitHub Actions runs automatically when anything is committed. You should check any complains from GitHub Actions. Beforehand you can check with `prove -v`.
* If it's a new feature, please consider writing a unit test for it. You can use e.g. `t/20_baseline_ipv4_http.t` as a template. The general documentation for [Test::More](https://perldoc.perl.org/Test/More.html) is a good start.
* GitHub actions are running automatically when anything is committed. You should see any complains. Beforehand you can check with `prove -v` from the "root dir"of tjhis project
* If it's a new feature, please consider writing a unit test for it. You can use e.g. `t/10_baseline_ipv4_http.t` or `t/61_diff_testsslsh.t` as a template. The general documentation for [Test::More](https://perldoc.perl.org/Test/More.html) is a good start.
* If it's a new feature, it would need to be documented in the appropriate section in `help()` and in `~/doc/testssl.1.md`

For the questions, just open an issue.
If you're interested in contributing and wonder how you can help, you can search for different tags in the issues (somehwat increasing degree of difficulty):

Check failure on line 17 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Check for spelling errors

somehwat ==> somewhat

Check failure on line 17 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Check for spelling errors

somehwat ==> somewhat
* [documentation](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:documentation)
* [good first issue](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:%22good%20first%20issue%22)
* [help wanted](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:%22help%20wanted%22)
* [for grabs](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:%22good%20first%20issue%22)

For questions just open an issue. Thanks for reading this!


0 comments on commit 90f1e59

Please sign in to comment.