When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a Pull Request Process, please follow it in all your interactions with the project.
- Creating a new branch off of the develop branch
- All changes to the code should have appropriate unit tests
- All code should match PSR-2 style
- Submit a pull request again develop as the base branch
- All travis checks will need to pass
-
Ensure the bug was not already reported by searching on GitHub under Issues.
-
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
-
Open a new GitHub pull request with the patch.
-
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
- Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
RetroAchievements.org is a volunteer effort. We encourage you to pitch in and join the team!
Thanks! ❤️ ❤️ ❤️
CONTRIBUTING file inspired/based on rails contrubiting