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

Edit CONTRIBUTING.md

Browse Source
This commit is contained in:
Hyeonho Kang
2025-01-23 13:10:12 +09:00
parent 2e8d4a1128
commit fb3921cd1b
1 changed files with 6 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@@ -1,21 +1,16 @@
### Contribution ### Contributing / participating
Contribution is always welcome, submit here (GitHub) or via e-mail. Contributing / participating is always welcome!
Please note the following: Please note the following:
* Please read at least the [coding convention](https://github.com/testssl/testssl.sh/blob/3.2/Coding_Convention.md). * 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. * 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. * Document your pull request, both in the pull request and/or commit message and in the code.
* Please test your changes thoroughly as reliability is important for this project. You may want to check different servers with different settings. * 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/pull requested. You should check any complains from Travis. Beforehand you can check with `prove -v`. * 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. * 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` * 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 or feel free to send us an e-mail. For the questions, just open an issue.
#### Contribute via e-mail
Of course it is fine when you want to send in patches to use e-mail. For the address, please grep for SWCONTACT in testssl.sh.
Let me know how you like them to be attributed.