These are the guidelines we try to follow while working on this project. We welcome contributions!
We are at an early stage of development however if you have questions about this project or how to use the starter kit please get in touch using our Gitter room.
If you find a bug, you can help us by reporting the issue:
-
If there is already an issue open for the problem, any additional information you can provide would be really useful.
-
If there is not already an issue open, please create one and include as much detail as possible to help us track down the problem.
Even better, you can submit a Pull Request with a fix!
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
We use our own forks and Github Flow to deliver changes to the code:
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've added any new features or made breaking changes, update the documentation.
- Ensure all the tests pass.
- Include a descriptive message and the Developer Certificate of Origin (DCO) sign-off on all commit messages.
- Issue a pull request!
- 4 spaces for indentation rather than tabs.
- Please to try to be consistent with the rest of the code and conform to the checkstyle rules.
Configure your identity:
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
Clone your forked repository:
git clone <forked_repository>
Add original repository as the upstream remote:
git remote add upstream <original_repository>
Make your changes in a new git branch:
git fetch upstream master
git checkout -b my-fix-branch upstream/master
Add changes for committing:
git add .
Commit your changes including the DCO sign-off:
git commit -s
Push your branch to GitHub:
git push origin my-fix-branch