Submitting Pull Requests

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! It's important that everyone follow the same formatting rules to prevent PRs from including textual changes that don't need to be made.

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!). The Reviewable feature of GitHub means that comments made by reviewers about your code will appear in the PR discussion instead to the Issue. Our goal is that review comments in the PR should be strictly about the code, while comments about why or whether something is done should be in the Issue discussion.

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 its description, followed by a brief summary of what was fixed or added. See previous versions of the file for examples.