-
Notifications
You must be signed in to change notification settings - Fork 183
Contributing
If you would like to contribute to OpenRW, there are a few ways to help out.
Please drop into the IRC channel #openrw on chat.freenode.net to discuss any questions about contributing.
If you have discovered an issue that has not already been reported, please report it. See the reporting issues page on the information that should be included with the report.
Some of the complex behaviour is not known. If you would like to help others make implementing OpenRW easier and more correct, please check out the issues tagged with behaviour. These issues document what behaviours need investigate to improve the implementation of OpenRW.
There are many open issues for bugs, enhancements and others. Tackling these tasks help get OpenRW closer to the goal of a 1.0 release.
We also keep a list of tasks to avoid having too many opened issues at once.
If you are submitting a pull request for OpenRW:
- Include a reference to any issue the pull request is intended to address.
- Keep unrelated changes in separate pull requests so they can be accepted individually.
- If you aren't ready to merge your changes but are looking for feedback, include "[not ready]" in the title.
- Changes in behaviour should be shown to match the behaviour in the original game, if applicable.
- Ensure that the test suite still passes after your change, updating tests if required.
These guidelines cover the types of changes that are likely to be accept and how to get those changes accepted.
- Changes that increase compatibility with the game data.
- Changes that fix incorrect behaviour.
- Fixes for technical issues, such as wide-screen or UHD resolution support.
- Feature enhancements, such as improved support for different input schemes.
- Changes where the ownership of the code is in question.
- Changes to support non-GTA titles.
Pull requests should be reviewed by as many people as possible for merging. Ideally at least two active contributors should review the changes before it is accepted, including the person who will accept the pull request.
If you have reviewed a pull request and think it should be accepted, comment with "+1" and leave any notes about the change you may have.
New code introduced by a change must follow the coding conventions to ensure new code is consistent.
Changes that are likely to cause problems on different platforms, such as including a new system header or adding a dependency should be reviewed on at least Linux, macOS and Windows to ensure that OpenRW continues to work on supported platforms.