mirror of https://github.com/PCSX2/pcsx2.git
3.4 KiB
3.4 KiB
So you want to contribute to PCSX2? Great
As a first step, please review these links as they'll help you understand how the development of the PCSX2 works. These pages are all found on the github wiki. You should probably also check out the forums.
- Just Starting Out
- Issue Reportding
- Pull Request Guidelines
- General Documentation And Coding Strategies
- Tasks
Just Starting Out
- If you're unfamilar with git, check out this brief introduction to Git
- How to build PCSX2 for Windows
- How to build PCSX2 for Linux
Issue Reportding
Pull Request Guidelines
The following is a list of general style recommendations that will make reviewing and merging easier:
- Commit Messages
- Please try to prefix your commit message, indicating what area of the project was modified.
- For example
gsdx: message.... - Looking at the project's commit history will help with keeping prefixes consistent overtime, there is no strictly enforced list.
- For example
- Try to keep messages brief and informative
- Remove unnecessary commits and squash commits together when appropriate.
- If you are not familiar with rebasing with git, check out the following resources:
- Please try to prefix your commit message, indicating what area of the project was modified.
- Code Styling and Formatting
- Consult the style guide
- Run
clang-formatusing the configuration file in the root of the repository- Visual Studio Setup - https://devblogs.microsoft.com/cppblog/clangformat-support-in-visual-studio-2017-15-7-preview-1/
- IMPORTANT - if you are running
clang-formaton unrelated changes (ie. formatting an entire file), please do so in a separate commit.- If you cannot scope your
clang-formatto just your changes and do not want to format unrelated code. Try your best to stick with the existing formatting already established in the file in question.
- If you cannot scope your