merge FAQ content into CONTRIBUTING
authorAaron Zauner <azet@azet.org>
Tue, 20 Dec 2016 11:47:38 +0000 (12:47 +0100)
committerAaron Zauner <azet@azet.org>
Tue, 20 Dec 2016 12:06:08 +0000 (13:06 +0100)
CONTRIBUTING.md

index 1a02041..f8ffb65 100644 (file)
@@ -1,14 +1,29 @@
 ## Contributing to BetterCrypto: Applied Crypto Hardening
 
-First off: thanks for helping out, every reviewer, committer and person
+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.
+to the project. Everybody is invited to work on this document and share
+their experience and expertise with us or ask questions if something
+isn't clear to them.
 
 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.
+feedback or critique - but might also save you some valuable time.
+
+### General Information
+
+* GitHub is used for Pull Requests, Code Review and PR related
+  discussion.
+* The main (publicly read-only) repository is hosted at
+https://git.bettercrypto.org/ach-master.git
+* The [BetterCrypto
+  mailing-list](https://lists.cert.at/cgi-bin/mailman/listinfo/ach) is the appropriate place for discussion
+  and source of information regarding larger changes throughout the document,
+  it's style, policy & in-depth discourse on minor and major details of the
+  guide we're working on. It's also a good place for general
+cryptography-, software-, appliance- or administrative related questions that may arise when reading or reviewing this document.
 
 ### Before you open a Pull Request (PR) on GitHub:
 
@@ -27,9 +42,10 @@ feedback or critique but might also save you some valuable time.
 Feel free to add your name/handle to `src/acknowledgements.tex` (alphabetical
 order).
 
+
 ### Resources
 
-* [Searching GitHub Pull Requests](https://github.com/BetterCrypto/Applied-Crypto-hardening/pulls?utf8=%E2%9C%93&q=)
+* [Search GitHub Pull Requests](https://github.com/BetterCrypto/Applied-Crypto-hardening/pulls?utf8=%E2%9C%93&q=)
 * [Mailing-list Archive](https://lists.cert.at/pipermail/ach/)