We love you to contribute to this project by filing bugs or helping others on the issue tracker or by contributing features/bug fixes through pull requests.
We use our issue tracker for project communication. When using the issue tracker,
- Be descriptive when creating an issue (what, where, when and how does a problem pop up)?
- Attach steps to reproduce (if applicable)
- Attach code samples, configuration options or stack traces that may indicate a problem
- Be helpful and respect others when commenting
Create a pull request if you would like to have an in-depth discussion about some piece of code.
We use pull requests for feature discussion and bug fixes. If you are not yet familiar on how to create a pull request, read this great guide.
Some things that make it easier for us to accept your pull requests
- The code adheres to our conventions
- spaces instead of tabs
- single-quotes
- ...
- The code is tested
- The
npm run allbuild passes (executes tests + linting) - The work is combined into a single commit
- The commit messages adhere to our guideline
We'd be glad to assist you if you do not get these things right in the first place.
Some notes for us maintainers only.
When merging, try to do it manually (rebase on current master). This avoids merge messages.
To release execute npm run release. Respect semantic versioning and choose correct next version based on latest changes.