[github/fretlink/hmacaroons.git] / CONTRIBUTING.md

How to contribute
=================
First and most important: Submit issues !

If you want to contribute, please fork the repo, and send us a pull request with
your changes.

Tests and cabal flags
---------------------
For this project we use the standard hunit/quickcheck tests.
If you want to submit a new feature, please try to integrate at least
*some* tests.

Code style
----------
We do not impose any specific style of code, but you can improve your code
by running it through `hlint`.

Crypto analysis
---------------
This library has **not** been audited by security experts !
It relies on an existing implementation and crypto libraries.

Any analysis is welcome, and I will gladly merge it.
Commit	Line	Data
7001a61e JT	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