Skip to main content

Contributing

Style Guidelines

  • Tabs over spaces

Git Guidelines

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Increase bonus to..." not "Increases bonus to...")
  • Reference issues and pull requests in the extended description
  • Start the commit message with an applicable emoji:
    • :sparkles: when adding new content or features
    • ♻️ :recycle: when reworking or moving a feature
    • 💔 :broken_heart: when removing a feature
    • 📝 :pencil: when adding new files
    • 🚚 :truck: when moving or renaming or files
    • 🔥 :fire: when removing files
    • 🎨 :art: when improving the format/structure of a document
    • ✏️ :pencil2: when fixing typos or phrasing
    • :libra: when fixing game balance
    • 🐛 :bug: when fixing a bug or error
    • 🔀 :twisted_rightwards_arrows: when merging branches
    • 🔖 :bookmark: when creating a release or tagging a version