Skip to content

Commit 90f1e59

Browse files
committed
Merge #2618 and doing some overdue amendments
1 parent 8f054c6 commit 90f1e59

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,21 @@ Contributing / participating is always welcome!
55

66
Please note the following:
77

8-
* Please read at least the [coding convention](https://github.com/testssl/testssl.sh/blob/3.2/Coding_Convention.md).
9-
* One pull request per feature or bug fix or improvement. Please do not mix issues.
10-
* Document your pull request, both in the pull request and/or commit message and in the code.
8+
* Please read the [coding convention](https://github.com/testssl/testssl.sh/blob/3.2/Coding_Convention.md).
9+
* If you have something new and/or bigger which you like to contribute, better open an issue first before you get frustrated.
10+
* Please one pull request per feature or bug fix or improvement. Please do not mix issues.
11+
* Documention pays off in the long run. So please your document your code and the pull request and/or commit message.
1112
* Please test your changes thoroughly as reliability is important for this project. You may want to check different servers with different settings.
12-
* GitHub Actions runs automatically when anything is committed. You should check any complains from GitHub Actions. Beforehand you can check with `prove -v`.
13-
* 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.
13+
* 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
14+
* 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.
1415
* If it's a new feature, it would need to be documented in the appropriate section in `help()` and in `~/doc/testssl.1.md`
1516

16-
For the questions, just open an issue.
17+
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):
18+
* [documentation](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:documentation)
19+
* [good first issue](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:%22good%20first%20issue%22)
20+
* [help wanted](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:%22help%20wanted%22)
21+
* [for grabs](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:%22good%20first%20issue%22)
22+
23+
For questions just open an issue. Thanks for reading this!
24+
25+

0 commit comments

Comments
 (0)