PCSX2/archived-pcsx2-net-www
1
0
Fork 0
mirror of https://github.com/PCSX2/pcsx2-net-www.git synced 2026-01-31 01:15:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
8eb66efbf93afcf5e14cabaf051f22b7cd79d93d
archived-pcsx2-net-www/docs/contributing/contributing.md
KamFretoZ 8eb66efbf9 Docs: Merge guides from GH Wiki (#405) 
* Docs: Merge guides from GH Wiki

Co-Authored-By: pandubz <redpanda4552@gmail.com>
Co-Authored-By: GovanifY <gauvain@govanify.com>

* README: Add Linux setup section

---------

Co-authored-by: pandubz <redpanda4552@gmail.com>
Co-authored-by: GovanifY <gauvain@govanify.com>
2025-05-22 16:46:39 +02:00

3.3 KiB
Raw Blame History

title, summary, draft, toc, sidebar_position
title summary draft toc sidebar_position
Contributing to PCSX2 Getting started with contributing to PCSX2 false true 1

In this section you will learn how to contribute to PCSX2.

As a first step, please review these links as they'll help you understand how the development of PCSX2 works.

How to Contribute

If you have no experience in programming or just want to help us in any shape or form, here is what you can do:

  • If you find application or emulation bugs, feel free to report an issue on our GitHub
  • If you have a knack for writing articles or testing games in general, we are always looking for help!
    • Please join our Discord if you are interested!
  • A game runs well or has a weird workaround? Head over to the Wiki and let us know on Discord!
  • Want to help translating PCSX2 to your language? Head over to Crowdin and start right away!

However if you do have experience in programming and wanted to contribute code, read on!

Just Starting Out

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 GS: message....
      • Looking at the project's commit history will help with keeping prefixes consistent overtime, there is no strictly enforced list.

    • 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:

  • Code Styling and Formatting

    • Consult the style guide

    • Run clang-format using the configuration file in the root of the repository

      • Visual Studio Setup
      • IMPORTANT - if you are running clang-format on unrelated changes (ie. formatting an entire file), please do so in a separate commit.
        • If you cannot scope your clang-format to 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.

General Documentation And Coding Strategies