Poodletooth-iLand/doc/style-guide/git-style.md

Git Style Guidelines

For Git, we try to follow a general pattern for commit messages and branch naming to make things organized and neat.

---

Commit Messages

All commit messages should:

• Start with a capital letter.
• Never end in puncuation.
• Be in the present tense.
• Have a title less than 100 characters.
• End in a new line.

If a description is provided in the commit message, it should be separated from the title by a blank line. If the commit addresses an issue, its issue number should be referenced at the end of the commit message's description.

Whenever possible, commit messages should be prefixed with the directory name of which the commit modified the most, followed by a colon and a space.

For example: toon: or tools: or ai:

Branch Naming

All branch names should:

• Be entirely lower case.
• Use - as a separator.
• Be categorized into one of the following groups:
  • wip
  • bugfix
  • test
  • enhancement
  • feature

For example: feature/parties or bugfix/toontorial or enhancement/fix-memory-leak