From 385485d39b096f21347c9aea3dfa6820c59d8b37 Mon Sep 17 00:00:00 2001 From: Dirk Wetter Date: Fri, 24 Jan 2020 11:33:11 +0100 Subject: [PATCH] More friendly phrased. Incl. soon to follow coding convention --- CONTRIBUTING.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48acd15..540ad04 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,17 @@ ### 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. -* Document your PR properly, both in the PR and/or commit message and in the code. -* Please test your changes thoroughly as reliability is important for this project. -* Follow the length [coding guideline](https://github.com/drwetter/testssl.sh/wiki/Coding-Style). +* Please read at least the [coding convention](https://github.com/drwetter/testssl.sh/Coding_Convention.md). +* One PR per feature or bug fix or improvement. Please do not mix issues. +* Document your PR, both in the PR 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. +* 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` - -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). +For questions just open an issue.