Contributions are always welcome. Before contributing please read the
code of conduct &
search the issue tracker; your issue
may have already been discussed or fixed in develop. To contribute:
- Fortk dzcode-io/leblad repository (see: How to fork a repository on Github).
- Install packages.
- Check if there's a dataset update by running
npm run update-dataset - Do your magic 😃, and please make sure that all tests are passing (run
npm test) - Commit your changes (we would be supper happy if you use commitzen).
- Send a pull request and point it to
developbranch.
We try to follow the git flow development model. Which means that we have a develop branch and master branch. All development is done under feature branches, which are (when finished) merged into the development branch. When a new version is released we merge the develop branch into the master branch.
If you would like to use git flow tools you are more than welcome to. We use it and it's pretty nifty. If you see a feature\ prefix on a comment then that is git flow automating branch creation. It does need more typing than just plain git so we suggest creating shell aliases for the commands.
Feature requests should be submitted in the issue tracker, with a description of the expected behavior & use case. Before submitting a request, please search for similar ones in the closed issues.
When logging a bug, please be sure to answer the following:
- A clear and concise description of what the bug is
- If at all possible, an isolated way to reproduce the behavior
- The behavior you expect to see, and the actual behavior
The issue tracker is for issues, in other words, bugs and suggestions. If you have a question, please contact us via EMail or any of our social links.