From df0849ad40969c9d47fffd09b75ec79724134dd3 Mon Sep 17 00:00:00 2001 From: Vincent Hanquez Date: Fri, 9 Dec 2016 15:06:05 +0000 Subject: [PATCH] add CONTRIBUTING guide - non definitive --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5d5f85e --- /dev/null +++ b/CONTRIBUTING.md @@ -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`