This guide shall help decide which prefix or prefixes commits should have. Multiple prefixes per commit are allowed. At least one prefix per commit is required.
The commit contains progress on or a completed new feature.
The commit tries to make the code more self-explaining and easier to understand. This can for example be achieved by commenting or renaming funtions or variables.
The commit improves on the code style. This can for example be achieved by refactoring, cleaning up imports, declaring values which can be final as final or reordering attributes and functions.
The commit handles an unspecified implementation detail. Decisions are almost never easy to make and will most of the time feel wrong for some people while being obviously correct to others. Unfortunately, most of the time an implementation has to go either way. Whenever an unspecified detail is implemented it should be well-documented and have a comment attached explaining why the decision was made as it is in the context of the structure of the software or the logical implications in Ocarina of Time and the randomizer.
The commit contains a modification on the software without the heavy implications of DECI. Changes are minor things which are easy to agree on.
The commit either handles unit testing or contains experimental code for debugging and development which is not supposed to stay in the final software.
The commit contains experimental code which is not supposed to stay in the final software.
The commit contains code for debugging and development which is not supposed to stay in the final software.
The commit contains an improvement for something already existing, making it either faster, more secure, more stable or is removing a redundancy.
The commit handles one or more preparations to preemptively reduce the work amount of upcoming commits or avoid unresolved symbols between two commits where functions are relocated.
The commit fixes an objectively wrong behaviour, typo or file.
The commit improves on the (graphical) user interface.
The commit improves on how the software is handled by the user. This may include automation of certain tasks in replacement of manual user input.
The commit either adds or corrects the documentation of this project.
Nothing except comments is changed in the commit.
The commit handles the deletion of obsolete files.
The commit handles the moving of files to different places in order to improve the project structure. This includes renaming files.
The commit either changes the README.md file, this file or anything related to GitHub pages, the repository appearance or the CNAME file.
The commit changes something about the graphics files of this software.
The commit concerns localization / language.