- Fork the repository from Github
- Do your proposed feature / fix
- You will want to check from waffle (link below) if something like your feature is being worked on or proposed and discuss it there.
- Create a Pull Request from your work
- If your work is related to an existing Github/waffle issue, add a
reference to it into the description with the 'closes' keyword. For
example:
closes #34
. - Your feature need not be ready when you create your pull request. The first goal of the PR is to facilitate discussion about the proposed feature or fix. So please create your pull request early.
- Our CI will pick the PR up and execute a build with tests and static code analysis.
- All of the tests need to pass and no new static code analysis issues may be reported. If there is a false positive, please commit the suppression of that including the justification. FindBugs and PMD issues are supressed with annotations in the relevant code, and coverity issues are supressed in coverity.yml in the root of the project. All suppressions will be reviewed before being accepted.
- If your work is related to an existing Github/waffle issue, add a
reference to it into the description with the 'closes' keyword. For
example:
- Add the label 'ready to merge' to your pull request once you are confident that your fork is ready to be merged taking into account all of the above.
- Your PR will be picked up and commented if necessary or merged as is.
