Game-Decompilation/sotn-decomp
1
0
Fork 0
mirror of https://github.com/Xeeynamo/sotn-decomp.git synced 2024-11-22 20:49:50 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#721)

Browse Source 
Add mention of contributing by renaming things
This commit is contained in:
bismurphy 2023-10-31 16:34:50 -04:00 committed by GitHub
parent 9ea031ffb3
commit 517b6628b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -8,6 +8,8 @@ While it's not a requirement to have fully played the game Castlevania: Symphony
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.