add textual links
[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. Everybody is invited to work on this document and share
6 their experience and expertise with us or ask questions if something
7 isn't clear to them.
8
9 Here's a few things we'd like you to consider when contributing to this
10 project as some issues and discussions seem to creep up on us every now
11 and again or have already been discussed at length in the past. This
12 does not only make it easier for us to incorporate your changes,
13 feedback or critique - but might also save you some valuable time.
14
15 ### General Information
16
17 * GitHub is used for Pull Requests, Code Review and PR related
18   discussion.
19 * The main (publicly read-only) repository is hosted at
20 https://git.bettercrypto.org/ach-master.git
21 * The [Applied Crypto Hardening mailing-list](https://lists.cert.at/cgi-bin/mailman/listinfo/ach) is the appropriate place for discussion
22   and source of information regarding larger changes throughout the document,
23   it's style, policy & in-depth discourse on minor and major details of the
24   guide we're working on. It's also a good place for general
25 cryptography-, software-, appliance- or administrative related questions that may arise when reading or reviewing this document.
26
27 ### Before you open a Pull Request (PR) on GitHub
28
29 1. [Search open and closed
30    issues](https://github.com/BetterCrypto/Applied-Crypto-hardening/pulls?utf8=%E2%9C%93&q=) for duplicates or previous discussions
31    related to the changes you propose.
32 2. Please take some time to read up on the [mailing list archives](https://lists.cert.at/pipermail/ach/) - over the years
33    we've discussed quite a few topics in depth and you might just find
34     the answer you were looking for or the reason we chose a certain
35    configuration setting.
36 3. If in doubt, ask on the mailing list before you open large pull
37    requests, refactor sections of the document or change security
38    critical settings in recommended service configuration files.
39
40 ### Attribution
41
42 Feel free to add your name/handle to `src/acknowledgements.tex` (alphabetical
43 order).
44
45 ### Get started
46
47 Clone, branch and commit or start a discussion on our mailing-list!
48
49
50 Thank you kindly! We hope you'll enjoy working with us on this document.
51