Xeeynamo/sotn-decomp
1
0 Fork 0
mirror of https://github.com/Xeeynamo/sotn-decomp.git synced 2026-11-07 09:16:07 -10:00
Code Issues Packages Projects Releases 1 Wiki Activity

Update CONTRIBUTING.md (#3552)

Browse Source
This commit is contained in:
Luciano Ciccariello authored and GitHub committed 2026-08-13 10:01:08 +01:00
1 parent abf99b84a5
commit 262370ef91
1 file changed
+5 -3
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+5 -3
View File
@@ -6,10 +6,12 @@ To get started with the project, the best way is to familiarize yourself with ho
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.
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. The list of issues is non-exhaustive, and you may need to file a new issue describing what you are planning to change before submitting a Pull Request.
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.
Another great first contribution could be renaming functions or variables. Because the initial priority in decompiling is functionality (rather than readability), most of their names are placeholders, and updating them just involves identifying the purpose and renaming these values; it does not require programming knowledge, and is therefore a great first contribution. Placeholder names are prepended with `func_`, `D_`, or `Unk`, and their purpose might be understood by observing them in 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 are a first-time contributor, you are required to give a heads-up before proposing any new Pull Request. We need to ensure your changes will not collide with work planned by seasoned contributors who wish to tackle it in the short term. Any changes you may propose in the form of a Pull Request must be justified and explained. We require commit messages and Pull Requests to be submitted without autonomous tooling such as an LLM or coding agent. Assistance from coding agents is allowed, but changes must be justifiable and manually operable. You must be confident in your changes before submission, and you will take full responsibility for them once a Pull Request is opened. If we observe that any of these rules are being ignored, we reserve the right to close your Pull Request without notice.
Please also 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.