Skip to content

Rules

Jump to bottom Edit New page
zumbak04 edited this page May 27, 2020 · 17 revisions

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. You may not read things not related to you: you may skip flag rules if you work on localization.

General Rules:

  1. NEVER commit directly to master except for in special circumstances. Anything that is in the master branch is ready for deployment. 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.
  2. ALWAYS add a list of changes (Changelog:) of your branch in the initial pull request comment. Visit This Page to see an example.
  3. ALWAYS mention how to test your features/fixes. If you changed some event, explain 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 These Guidelines to get more information.
  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/CoA Rules:

  1. Make sure that your flag/CoA emblem DOES NOT go beyond and BARELY touch these borders (see below) thus we're sure the flag/CoA isn't too big or too small. Alternatively, these borders can be found in Warcraft-Guardians-of-Azeroth\.artist_resources\flags\Borders.png.
Borders

Localization Rules:

  1. DO NOT open .csv files in any program except OpenOffice Calc using These Settings or a simple text editor like Notepad++. If you open Russian localization files, use Cyrillic (Windows-1251) instead of Western Europe (Windows-1252/WinLatin 1).
  2. DO NOT change 00_Barony_names.csv, 00_County_names.csv, 00_Duchy_names.csv, 00_Empire_names, 00_Kingdom_names.csv, 00_Province_names.csv, it's auto-generated content. Your localization there just will disappear. BUT! If you want to translate a title or province name, copy the title or province code name (text from the first column like k_orsis, k_orsis_adj) and paste into 000_Other_title_names.csv or create a new file (file must start with 000_) and write localization there. Localization in 000_Other_title_names.csv or your new file will overwrite auto-generated localization.
Example

  1. DO NOT click Commit suggestion button on GitHub if the change is suggested in localization files (when someones leave a review with suggestions). GitHub doesn't support ANSI encoding thus clicking this button will break the entire localization file. If you want to apply that suggestion, just copy it from GitHub and paste in files manually.
Add a custom footer
Add a custom sidebar
Clone this wiki locally