Skip to content

Commits

Use conventional commits to structure your commit messages.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
  • A commit should represent a single unit of work
  • Ideally each commit should represent the codebase in a buildable/runnable state, however this isn't always possible
  • Commit messages are a very helpful source when performing archaeology on the codebase, and so should ideally always aim to include the "what" in the <description> and the "why" in the <body>