Merge pull request #3072 from testssl/my-patch-1

AI section + minor improvements

.github/pull_request_template.md

@@ -1,22 +1,36 @@
+<!--
 
 ## Describe your changes
+Please refer to an issue here or describe the change thoroughly in your PR and check the boxes which are applicable. 
 
-Please refer to an issue here or describe the change thoroughly in your PR.
+This includes:
+- Resolved or fixed issue: <-- ✍️ Add GitHub issue number in format `#0000` 
+- A clear and concise summary of the change and which issue (if any) it fixes. Should also include relevant motivation and context.
+
+-->
 
 ## What is your pull request about?
 - [ ] Bug fix
 - [ ] Improvement
 - [ ] New feature (adds functionality)
 - [ ] Breaking change (bug fix, feature or improvement that would cause existing functionality to not work as expected)
-- [ ] Typo fix
+- [ ] Typo / spelling fix
 - [ ] Documentation update
 - [ ] Update of other files
 
 
 ## If it's a code change please check the boxes which are applicable
 - [ ] For the main program: My edits contain no tabs, indentation is five spaces and any line endings do not contain any blank chars
-- [ ] I've read CONTRIBUTING.md and Coding_Convention.md 
+- [ ] I've read [CONTRIBUTING.md](https://github.com/testssl/testssl.sh/blob/3.3dev/CONTRIBUTING.md)
+- [ ] My code follows [Coding_Convention.md](https://github.com/testssl/testssl.sh/blob/3.3dev/Coding_Convention.md) 
 - [ ] I have tested this __fix__ or __improvement__ against >=2 hosts and I couldn't spot a problem
 - [ ] I have tested this __new feature__ against >=2 hosts which show this feature and >=2 host which does not (in order to avoid side effects) . I couldn't spot a problem
 - [ ] For the __new feature__ I have made corresponding changes to the documentation and / or to ``help()``
-- [ ] If it's a bigger change: I added myself to CREDITS.md (alphabetical order) and the change to CHANGELOG.md
+- [ ] If it's a bigger change: I added myself to [CREDITS.md](https://github.com/testssl/testssl.sh/blob/3.3dev/CREDITS.md) (alphabetical order) and the change to [CHANGELOG.md](https://github.com/testssl/testssl.sh/blob/3.3dev/CHANGELOG.md)
+
+## AI section
+- [ ] My contribution does not include any AI-generated content
+- [ ] My contribution includes AI-generated content, as disclosed below:
+    - AI Tools: `[e.g. GitHub CoPilot, JetBrains Junie, VS Code plugin <NAME> etc.]`
+    - LLMs and versions: `[e.g. GPT-A.B, Claude <NAME> A.B, Gemini A.B <NAME>, Qwen<B>-Coder, DeepSeek-<A>  etc.]`
+

CONTRIBUTING.md

@@ -8,11 +8,11 @@ Please note the following:
 * Please read the [coding convention](https://github.com/testssl/testssl.sh/blob/3.3dev/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.
-* Documentation pays off in the long run. So please your document your code and the pull request and/or commit message.
-* Please test your changes thoroughly as reliability is important for this project. You may want to check different servers with different settings.
-* GitHub actions are running automatically when anything is committed. You should see any complaints. Beforehand you can check with `prove -v` from the "root dir" of this project.
+* Please test your changes thoroughly as reliability is important for this project. You may want to check different servers with different settings. Also a run with a different client might help.
+* GitHub actions are running automatically when anything is committed. You should see any complaints. Beforehand you can check with `prove -v` from the "root dir" of this project for the whole run, a single (perl) script with `./t/NR_NAME.t`.
 * 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`
+* Documentation pays off in the long run. So please your document your code and the pull request and/or commit message. You only have to change `~/doc/testssl.1.md` . The HTML and roff file should be autogenerated by github (see if you PR adds those files).
 
 If you're interested in contributing and wonder how you can help, you can search for different tags in the issues (somewhat increasing degree of difficulty):
 * [documentation](https://github.com/testssl/testssl.sh/issues?q=is:issue%20state:open%20label:documentation)