add CONTRIBUTING.md file for github PRs
authorAaron Zauner <azet@azet.org>
Tue, 20 Dec 2016 11:36:12 +0000 (12:36 +0100)
committerAaron Zauner <azet@azet.org>
Tue, 20 Dec 2016 11:36:12 +0000 (12:36 +0100)
CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..2259bb0
--- /dev/null
@@ -0,0 +1,33 @@
+## Contributing to BetterCrypto: Applied Crypto Hardening
+
+First off: thanks for helping out, every reviewer, committer and person
+interested in discussing our document and changes is a valuable addition
+to the project.
+
+Here's a few things we'd like you to consider when contributing to this
+project as some issues and discussions seem to creep up on us every now
+and again or have already been discussed at length in the past. This
+does not only make it easier for us to incorporate your changes,
+feedback or critique but might also save you some valuable time.
+
+### Before you open a Pull Request (PR) on GitHub:
+
+1. Search open and closed issues for duplicates or previous discussions
+   related to the changes you propose.
+2. Please take some time to read up on the mailing list - over the years
+   we've discussed quite a few topics in depth and you might just find
+    the answer you were looking for or the reason we chose a certain
+   configuration setting.
+3. If in doubt, ask on the mailing list before you open large pull
+   requests, refactor sections of the document or change security
+   critical settings in recommended service configuration files.
+
+### Resources
+
+* Searching Pull Requests:
+  https://github.com/BetterCrypto/Applied-Crypto-hardening/pulls?utf8=%E2%9C%93&q=
+* Mailing list: https://lists.cert.at/cgi-bin/mailman/listinfo/ach
+
+
+Thank you!
+