add CONTRIBUTING.md file for github PRs
[ach-master.git] / CONTRIBUTING.md
1 ## Contributing to BetterCrypto: Applied Crypto Hardening
2
3 First off: thanks for helping out, every reviewer, committer and person
4 interested in discussing our document and changes is a valuable addition
5 to the project.
6
7 Here's a few things we'd like you to consider when contributing to this
8 project as some issues and discussions seem to creep up on us every now
9 and again or have already been discussed at length in the past. This
10 does not only make it easier for us to incorporate your changes,
11 feedback or critique but might also save you some valuable time.
12
13 ### Before you open a Pull Request (PR) on GitHub:
14
15 1. Search open and closed issues for duplicates or previous discussions
16    related to the changes you propose.
17 2. Please take some time to read up on the mailing list - over the years
18    we've discussed quite a few topics in depth and you might just find
19     the answer you were looking for or the reason we chose a certain
20    configuration setting.
21 3. If in doubt, ask on the mailing list before you open large pull
22    requests, refactor sections of the document or change security
23    critical settings in recommended service configuration files.
24
25 ### Resources
26
27 * Searching Pull Requests:
28   https://github.com/BetterCrypto/Applied-Crypto-hardening/pulls?utf8=%E2%9C%93&q=
29 * Mailing list: https://lists.cert.at/cgi-bin/mailman/listinfo/ach
30
31
32 Thank you!
33