|
| 1 | +# Introduction |
| 2 | + |
| 3 | +## Acknowledgements |
| 4 | + |
| 5 | +Thank you for considering contributing to PCSX-Redux. The aim of the project is to |
| 6 | +be a useful debugging and reverse engineering tool, but any sort of help is greatly |
| 7 | +appreciated. There are various areas of the project that can be improved, and lots |
| 8 | +of work is still required. Feel free to open a discussion if there's anything |
| 9 | +you'd like to talk about. |
| 10 | + |
| 11 | +## Licensing your contribution |
| 12 | + |
| 13 | +By submitting a pull request, you represent that you have the right to license your contribution |
| 14 | +to the PCSX-Redux authors and the community, and agree by submitting the patch that |
| 15 | +your contributions are licensed under the project's license. |
| 16 | + |
| 17 | +## Why should you read this guideline? |
| 18 | + |
| 19 | +Following this guideline will help you to keep contact with the PCSX-Redux team. |
| 20 | +This will result in shorter time to process your bug reports, suggestions and pull requests. |
| 21 | + |
| 22 | +## Ways of contributing to PCSX-Redux |
| 23 | + |
| 24 | +You may contribute in a number of ways, including: |
| 25 | + |
| 26 | +* Contributing new features or bugfixes. |
| 27 | +* Filing detailed bug reports. |
| 28 | +* Suggesting new features. |
| 29 | +* Contributing to the [documentation](https://pcsx-redux.consoledev.net/) in the [docs](https://github.com/grumpycoders/pcsx-redux/tree/docs) branch. |
| 30 | +* Contributing unit test cases. |
| 31 | + |
| 32 | +# Contributing to PCSX-Redux |
| 33 | + |
| 34 | +## Code of conduct |
| 35 | + |
| 36 | +Please read and follow the [Code of Conduct](CODE_OF_CONDUCT.md) before contributing. |
| 37 | + |
| 38 | +## Contributing documentation |
| 39 | + |
| 40 | +* Provide improvements as small as possible, as pull requests. |
| 41 | +* If a change in documentation structure is needed, we prefer that you file a suggestion. |
| 42 | + |
| 43 | +## Contributing code |
| 44 | + |
| 45 | +* For non-trivial issues or changes, please file an issue where we can discuss the course of action. |
| 46 | +* Software pull requests should be as small as possible and providing only one feature per pull request. |
| 47 | +* The codebase is using C++-20, so all features from there are fair game, provided it builds on all of the supported platforms. Submitting a pull request should trigger builds for all supported platforms. |
| 48 | +* Please try and follow the codestyle, which is enforced by the [clang-format](https://github.com/grumpycoders/pcsx-redux/blob/main/src/.clang-format) rules. Worst case scenario, a bot will issue another PR to fix the codestyle however, so no need to sweat it too much. |
| 49 | + |
| 50 | +## Filing a bug report |
| 51 | + |
| 52 | +If you find a bug, please as much as possible try to file a detailed bug report using the [issue template](https://github.com/grumpycoders/pcsx-redux/issues/new?assignees=&labels=&template=bug_report.yml). |
0 commit comments