haskell/cryptonite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add CONTRIBUTING guide - non definitive

Browse Source
This commit is contained in:
Vincent Hanquez 2016-12-09 15:06:05 +00:00
parent 2a91fe31be
commit df0849ad40
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,10 @@
cryptonite guideline
--------------------
not a definitive list:
* 4-spaces for indentation
* don't use bytestring directly, use the `memory` abstraction
* hard errors should represented by the equivalent Crypto.Error.Types. Possibly reuse a matching value, otherwise create one.
* don't use 'error', use throwCryptoError (or the IO cousin) if needed
* don't add dependencies without a really really really strong motivation. only exception: `foundation`