Contribution guidelines - ParadoxZero/libgeneric GitHub Wiki
-
Always start with an issue
An issue is always a starting point of any contribution. It will allow for a space to discuss implementation strategy while also telling everyone else about the work being done, this will help avoid duplication.
-
Mark the issue being contributed to as
currently working
(label).Optionally, assign the issue to yourself.
-
Do not modify
README.md
-
Any contribution should follow the code guide.
-
Every API should have a test (sample) written for it which will ensure it is working.
This piece of code should be placed in
Test/<container>/
. Or in case of algorithms,Test/algorithm
.