Pull Request Guidelines

Adding commits

Once a PR has been reviewed, do not add more commits other than to resolve the comments. This makes it harder for reviewers and lengthens the time to get a PR through review.

Single purpose

A PR should ideally accomplish one thing. Good examples are:

• Decompiling a single larger function
• Decompiling multiple smaller functions
• Renaming a symbol
• Changing something about the build system
• Rearranging code

A PR that does all of those things is much harder to review.

This does not prohibit combining certain things that make logical sense. For example:

Decompiling a function and renaming it can be in a single PR. However, if the renaming touches a lot of files it probably makes more sense to split it.

Follow the naming and style guidelines

See https://github.com/Xeeynamo/sotn-decomp/blob/master/docs/NAMING.md and https://github.com/Xeeynamo/sotn-decomp/blob/master/docs/STYLE.md