Contribute to this Project

Code

We’re thrilled that you’d like to contribute to this project. You can do this by submitting a pull request.

  1. Take a look at our Development Guide to get an idea of how we work

  2. Fork and clone the repository

  3. Create a new branch: git checkout -b my-branch-name

  4. Make your changes and include tests (preferably by using TDD)

  5. Make sure the tests pass

  6. Format code and build artifacts

  7. Push to your fork and submit a pull request

  8. Pat your self on the back and wait for your pull request to be reviewed and merged

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  1. Write tests

  2. Make sure the documentation (docs folder) and any other relevant documentation are kept up-to-date

  3. We try to follow SemVer v2.0.0 so randomly breaking public APIs is not an option

  4. Keep your change as focused as possible - If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests

  5. Write a good commit message

Bug Reports

We’d love to hear your feedback on this project. Please feel free to submit an issue explaining the bug you’ve found. Please use the issue template for Bug Reports to ensure that we have all the necessary information to reproduce the bug.

Feature Requests

We’d love to hear your feedback on this project. Please feel free to submit an issue explaining your feature request. We’re also open to ideas and suggestions for improvements.

To increase the likelihood of your feature request being accepted, please write your request in the form of a user story and add some acceptance criteria (which ideally can be turned into automated tests).