You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,25 @@
1
1
2
-
### Contributions / participation
2
+
### Contributing / participating
3
3
4
-
is always welcome, here @ github or via e-mail.
4
+
Contributing / participating is always welcome!
5
5
6
-
Note please the following
6
+
Please note the following:
7
7
8
-
* Please read at least the [coding convention](https://github.com/drwetter/testssl.sh/Coding_Convention.md).
9
-
* One PR per feature or bug fix or improvement. Please do not mix issues.
10
-
* Document your PR, both in the PR 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
+
* Documentation pays off in the long run. So please your document your code and the pull request and/or commit message.
11
12
* Please test your changes thoroughly as reliability is important for this project. You may want to check different servers with different settings.
12
-
*Travis runs automatically when anything is committed/PR'd. You should check any complains from Travis. 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.
14
-
* If it's a new feature it would need to be documented in the appropriate section in `help()` and in `~/doc/testssl.1.md`
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 this 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.
15
+
* If it's a new feature, it would need to be documented in the appropriate section in `help()` and in `~/doc/testssl.1.md`
15
16
16
-
For questions just open an issue or feel free to send me an e-mail.
17
+
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):
`testssl.sh` is a free command line tool which checks a server's service on
11
11
any port for the support of TLS/SSL ciphers, protocols as well as some
@@ -45,16 +45,16 @@ due to bash-socket-based checks. As a result you can also use e.g. LibreSSL or O
45
45
(silent) check for binaries is done when you start testssl.sh . System V needs probably
46
46
to have GNU grep installed. MacOS X and Windows (using MSYS2, Cygwin or WSL) work too.
47
47
48
-
Update notification here or @ [mastodon](https://infosec.exchange/@testssl) (old: [twitter](https://twitter.com/drwetter))
48
+
Update notification here or @ [mastodon](https://infosec.exchange/@testssl or [bluesky](https://bsky.app/profile/testssl.bsky.social). Please note the [twitter](https://twitter.com/drwetter) account is not being used anymore.
49
49
50
50
### Installation
51
51
52
52
You can download testssl.sh branch 3.2 just by cloning this git repository:
3.2 is now the latest branch which evolved from 3.1dev. It's in the release candidate phase.
57
-
For the former stable version help yourself by downloading the [ZIP](https://codeload.github.com/drwetter/testssl.sh/zip/v3.0.8) or [tar.gz](https://codeload.github.com/drwetter/testssl.sh/tar.gz/v3.0.8) archive. Just ``cd`` to the directory created (=INSTALLDIR) and run it off there.
56
+
3.2 is now the latest branch which evolved from 3.1dev. It's in the release candidate phase and considered as stable.
57
+
For the former stable version named oldstable please help yourself by downloading the [ZIP](https://codeload.github.com/testssl/testssl.sh/zip/v3.0.9) or [tar.gz](https://codeload.github.com/testssl/testssl.sh/tar.gz/v3.0.9) archive. Just ``cd`` to the directory created (=INSTALLDIR) and run it off there.
58
58
59
59
#### Docker
60
60
@@ -69,19 +69,19 @@ Or if you have cloned this repo you also can just ``cd`` to the INSTALLDIR and r
For more please consult [Dockerfile.md](https://github.com/drwetter/testssl.sh/blob/3.2/Dockerfile.md).
72
+
For more please consult [Dockerfile.md](https://github.com/testssl/testssl.sh/blob/3.2/Dockerfile.md).
73
73
74
74
### No Warranty
75
75
76
-
Usage of the program is without any warranty. Use it at yor own risk.
76
+
Usage of the program is without any warranty. Use it at your own risk.
77
77
78
78
Testssl.sh is intended to be used as a standalone CLI tool. While we tried to apply best practise security measures, we can't guarantee that the program is without any vulnerabilities. Running as a service may pose security risks and you're recommended to apply additional security measures.
79
79
80
80
### Status
81
81
82
-
We're currently in the release candidate phase for version 3.2. Bigger features will be developed in a separate branch before merged into a 3.3dev to avoid hiccups or inconsistencies.
82
+
We're currently in the release candidate phase for version 3.2. You should use it despite the label "RC". Bigger features will be developed in a separate branch before merged into a 3.3dev to avoid hiccups or inconsistencies.
83
83
84
-
Version 3.0.X receives bugfixes, labeled as 3.0.1, 3.0.2 and so on. This will happen until 3.2 is released.
84
+
Version 3.0.X receives bugfixes, labeled as 3.0.1, 3.0.2 and so on. This will happen until 3.2 is finally released.
85
85
86
86
Support for 2.9.5 has been dropped. Supported is >= 3.0.x only.
87
87
@@ -93,16 +93,19 @@ Support for 2.9.5 has been dropped. Supported is >= 3.0.x only.
93
93
94
94
### Contributing
95
95
96
-
Contributions are welcome! See [CONTRIBUTING.md](https://github.com/drwetter/testssl.sh/blob/3.2/CONTRIBUTING.md) for details. Please also have a look at the [Coding Convention](https://github.com/drwetter/testssl.sh/blob/3.2/Coding_Convention.md).
96
+
Contributions are welcome! See [CONTRIBUTING.md](https://github.com/testssl/testssl.sh/blob/3.2/CONTRIBUTING.md) for details. Please also have a look at the [Coding Convention](https://github.com/testssl/testssl.sh/blob/3.2/Coding_Convention.md). A lot of contributors already helped to push the project where it currently is, see [CREDITS.md](https://github.com/testssl/testssl.sh/blob/3.2/CREDITS.md). We still you use your help now. A start would be look for issues which are labeled as [good first issue](https://github.com/testssl/testssl.sh/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), [for grabs](https://github.com/testssl/testssl.sh/issues?q=is%3Aissue+is%3Aopen+label%3A%22for+grabs%22) or [help wanted](https://github.com/testssl/testssl.sh/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). The latter is more advanced.
97
+
98
+
In general there's some maintenance burden, like maintaining handshakes and CA stores, writing unit tests, improving github actions. If you believe you can contribute, speak up.
99
+
97
100
98
101
### Bug reports
99
102
100
103
Bug reports are important. It makes this project more robust.
101
104
102
105
Please file bugs in the issue tracker @ GitHub. Do not forget to provide detailed information, see template for issue, and further details @
103
-
https://github.com/drwetter/testssl.sh/wiki/Bug-reporting. Nobody can read your thoughts -- yet. And only agencies your screen ;-)
106
+
https://github.com/testssl/testssl.sh/wiki/Bug-reporting. Nobody can read your thoughts -- yet. And only agencies your screen ;-)
104
107
105
-
You can also debug yourself, see [here](https://github.com/drwetter/testssl.sh/wiki/Findings-and-HowTo-Fix-them).
108
+
You can also debug yourself, see [here](https://github.com/testssl/testssl.sh/wiki/Findings-and-HowTo-Fix-them).
106
109
107
110
----
108
111
@@ -129,7 +132,7 @@ Please address questions not specifically to the code of testssl.sh to the respe
129
132
130
133
#### Brew package
131
134
132
-
* see [#233](https://github.com/drwetter/testssl.sh/issues/233) and
135
+
* see [#233](https://github.com/testssl/testssl.sh/issues/233) and
0 commit comments