Rules

Hello! Here you will find a list of rules that we follow in order not to break anything. Please read them very carefully before starting work.

General Rules:

1. NEVER commit directly to master except for in special circumstances. Anything that is in the master branch is always deployable. So, we must create separate branches and test them before implementing them into master or we may end up with an undeployable and broken master. For more, Visit This Page.
2. ALWAYS add a list of changes (Changelog:) of your branch in the pull request. Visit This Page to see an example.
3. ALWAYS mention how to test your features/fixes. If you changed some event, tell how to fire it etc. Visit This Page and This Page to see an example.
4. ALWAYS describe commits clearly, so that the commit can be used to compile larger logs and patch notes. Visit This Page and This Page to see an example.
5. If your pull request is currently a work in progress and requires more commits before review/finalization, ALWAYS write in "WIP" at the end of your pull request title. This will have GitHub mark it as a pull request that should not be merged yet.

Flag Rules:

1. Make sure that your flag/CoA emblem DOES NOT go beyond these borders: Warcraft-Guardians-of-Azeroth\artist_resources\flags.

Localization Rules:

1. ALWAYS add new localization at the end of the file.