Skip to content

Submitting Pull Requests

Jamz edited this page Feb 12, 2019 · 10 revisions

Thanks for the code submission! Being an Open Source project means anyone can submit code changes to fix issues or add enhancements. All Pull Requests will need to be approved by one of the Core Developers, but before doing so you will need to follow some simple guidelines.

  1. It will need to pass all Checks. This means our Continuous Integration will spawn and attempt to build your Pull Request. A common cause for failure is code formatting. Be sure to run './gradlew spotlessApply' before checking in your code to insure your code formatting follows our standards!

  2. All changes should have an open GitHub Issue and the commits should mention the issue by number, like "Added i18n strings to fix issue #206". Feel free to comment on an Issue before working on it to have it assigned so multiple people don't work on the same issue (unless needed!).

  3. CHANGE_LOG.md should be updated, adding the Issue(s) you are completing to the top of the list. It should include a link to the Issue # and it's description, followed by a brief summary of what was fixed or added.