Skip to content

Github and General Guidelines

zumbak04 edited this page Apr 10, 2021 · 7 revisions

Hello! Here we explain our guidelines about creating PRs, committing to the repository, and operating with text files.

Github Guidelines

  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 describe commits clearly, so that the commit can be used to compile larger logs and patch notes. Visit These Guidelines to get more information.
  3. If you want to commit changes that aren't yours, are completely generated, moved from one place to another or contain a lot of deleted lines, commented out lines, please TRY TO write in "(GDC)" at the end of your commit message.
  4. PLEASE read these GitHub Text Tricks. They will help in communicating on GitHub.

General Guidelines

  1. TRY TO add wc at the beginning of non-vanilla files (created for this mod), so we can distinguish which files are related to the mod. Examples: wc_third_war_events.txt, wc_event_modifiers.txt.
  2. I recommend using Total Commander to search for text within files. This is useful when you need to find all the references.