Skip to content

Github and General Guidelines

zumbak04 edited this page Jul 12, 2021 · 7 revisions

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

Github Guidelines

  1. Make your commit name and commit comment to be informative. Telling what you have added or changed.
  2. Write GDC (used by the teamlead to sort commits that shouldn't end in monthly contribution) in your commit comment if your commit contains:
    • Other's work
    • Auto-generated content
    • Find and replace
    • Huge (50 lines and more) line removing, moving, copying
  3. 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.

Tools:

  • I recommend using Total Commander to search for text within files. This is useful when you need to find all the references.