Git/testssl.sh
1
0
Fork 0
mirror of https://github.com/drwetter/testssl.sh.git synced 2025-10-31 13:55:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

More friendly phrased. Incl. soon to follow coding convention

Browse Source
This commit is contained in:
Dirk Wetter
2020-01-24 11:33:11 +01:00
parent 67598e824f
commit 385485d39b
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@@ -1,15 +1,17 @@
### Contributions / participation ### Contributions / participation
is always welcome. is always welcome!
Note please that following is strongly requested: Note please the following:
* One PR per feature or bug fix or improvement. * Please read at least the [coding convention](https://github.com/drwetter/testssl.sh/Coding_Convention.md).
* Document your PR properly, both in the PR and/or commit message and in the code. * One PR per feature or bug fix or improvement. Please do not mix issues.
* Please test your changes thoroughly as reliability is important for this project. * Document your PR, both in the PR and/or commit message and in the code.
* Follow the length [coding guideline](https://github.com/drwetter/testssl.sh/wiki/Coding-Style). * Please test your changes thoroughly as reliability is important for this project. You may want to check different servers with different settings.
* Travis runs automatically when anything is committed/PR'd. You should check any complains from Travis. 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.
* 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 questions just open an issue.
If it's a new feature please consider writing a unit test for it. There's a directory ~/t/ which Travis runs automatically when anything is committed. You can use e.g. `20_baseline_ipv4_http.t` as a template. There's also [general documentation for Test::More](https://perldoc.perl.org/Test/More.html).