-
-
Notifications
You must be signed in to change notification settings - Fork 52
Rules
zumbak04 edited this page Dec 2, 2019
·
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.
-
NEVER commit directly to
master
except for in special circumstances. Anything that is in themaster
branch is ready for deployment. So, we must create separate branches and test them before implementing them intomaster
or we may end up with an undeployable and brokenmaster
. For more, Visit This Page. - ALWAYS add a list of changes (Changelog:) of your branch in the initial pull request comment. Visit This Page to see an example.
- 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.
- 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. If you use TortoiseGit, the first line of the commit message is a commit's summary, it must be as short and clear as possible, keep it in mind.
- 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.
- Make sure that your flag/CoA emblem DOES NOT go beyond these borders:
Warcraft-Guardians-of-Azeroth\artist_resources\flags
.
-
DO NOT open
.csv
files in any program except OpenOffice Calc using These Settings. If you open Russian localization files, useCyrillic (Windows-1251)
instead ofWestern Europe (Windows-1252/WinLatin 1)
. -
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 likek_orsis
,k_orsis_adj
) and paste into000_Other_title_names.csv
or create a new file (file must start with000_
) and write localization there. Localization in000_Other_title_names.csv
or your new file will overwrite auto-generated localization.
Example