We are happy for you taking the time to contribute! We appreciate your help with feature implementation, bug fixes, unit tests, or just for reporting the issues and improvement ideas.
- Main project repo is hosted on Gitlab, but we have a mirrored repo hosted on GitHub
- Developer instructions are available in the README.md
- Project's main issue tracker is here and this is the prefered place to post issues. Alternatively, you may post issues to the issue tracker of the mirror repo on GitHub.
- To contact the maintainers of the project, feel free to send an email to [email protected]
Details on how to build and set up the project are available in the README.md.
We use Jest for unit testing. We would always be happy to increase unit test coverage. Please write unit tests for new code that you create.
You may report bugs to the issue tracker. To do so, please fill this issue template.
Please create a merge request to our project's Gitlab repo. As a merge request description, please fill in the merge request description template here. We would be very grateful if you would include Jest unit tests for the added code.
Make sure that all of your commits are atomic (i. e. addressing not more than one feature per commit) and always write a clear message for your commits.
For branch names, use convention fix/ISSUE_NUMBER-<FIX_SUMMARY> for bug fixes and feat/ISSUE_NUMBER-<FEAT_SUMMARY> for feature implementations.
Contributions to this repository are subject to the Developer Certificate of Origin. All commits should be signed off by either using -s or --signed flag while committing:
git commit -s -m "My commit message"
Alternatively, you can add additional line to the commit message:
My commit message
Signed-off-by: Dev McDeveloper <[email protected]>
You may post feature/enhancement requests on the project's issue tracker. To do so, please fill this issue template.