mirror of
https://github.com/Xeeynamo/sotn-decomp.git
synced 2024-11-23 13:09:44 +00:00
16 lines
1.6 KiB
Markdown
16 lines
1.6 KiB
Markdown
# Contributing to Castlevania: Symphony of the Night Decompilation
|
|
|
|
Thank you for your interest in joining our project's journey!
|
|
|
|
To get started with the project, the best way is to familiarize yourself with how to [build](https://github.com/Xeeynamo/sotn-decomp/wiki/Build) the project and understand the process of [decompiling](https://github.com/Xeeynamo/sotn-decomp/wiki/Decompilation).
|
|
|
|
While it's not a requirement to have fully played the game Castlevania: Symphony of the Night before you begin, it's beneficial to know the game in order to have a broad understanding of what the codebase does.
|
|
|
|
We maintain a list of [good first issues](https://github.com/Xeeynamo/sotn-decomp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that can serve as potential entry points to start contributing.
|
|
|
|
Another great first contribution could be renaming functions or variables. Because the initial priority in decompiling is functionality (rather than readability), most of them are placeholders. Updating them just involves identifying the purpose and renaming these values; it does not require programming knowledge and therefore is a great first contribution. Placeholder names are pre-pended by `func_`, `D_` or `Unk` and their purpose might be understood by plugging them into a PlayStation 1 debugger.
|
|
|
|
Please note that, at this time, we are NOT accepting Pull Requests that only aim to fix spelling errors or reorganize sentences, as we prioritize contributions with a more significant impact.
|
|
|
|
If you have any further questions, please refer to our [README](https://github.com/Xeeynamo/sotn-decomp#readme) for contact information and additional resources.
|