diff options
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3e85b0b --- /dev/null +++ b/CONTRIBUTING.md | |||
@@ -0,0 +1,26 @@ | |||
1 | How to contribute | ||
2 | ================= | ||
3 | First and most important: Submit issues ! | ||
4 | |||
5 | If you want to contribute, please fork the repo, and send us a pull request with | ||
6 | your changes. | ||
7 | |||
8 | Tests and cabal flags | ||
9 | --------------------- | ||
10 | For this project we use the standard hunit/quickcheck tests. | ||
11 | If you want to submit a new feature, please try to integrate at least | ||
12 | *some* tests. | ||
13 | |||
14 | Code style | ||
15 | ---------- | ||
16 | We do not impose any specific style of code, but you can improve your code | ||
17 | by running it through `hlint`. | ||
18 | |||
19 | Crypto analysis | ||
20 | --------------- | ||
21 | This library has **not** been audited by security experts ! | ||
22 | It relies on an existing implementation and crypto libraries. | ||
23 | |||
24 | Any analysis is welcome, and I will gladly merge it. | ||
25 | |||
26 | |||