Skip to main content

Commit Message Guidelines

Writing clear and well-structured commit messages improves collaboration, makes code history more readable, and helps with debugging. This guide provides best practices for writing effective commit messages.

General Guidelines​

  • Keep it concise: keep the subject line concise, ideally under 50 characters. If necessary, do not exceed 72 characters to maintain readability. This follows the Git commit best practices.
  • PR title consideration: when opening a pull request with a single commit, the commit message will be used as the PR title—so make it meaningful.
  • Add details when needed: if additional context is required, add a blank line after the subject and provide a more detailed explanation in the body.
  • Capitalize the subject line, as you would in a sentence.
  • Do not end the subject line with a period (.) to keep it clean.
  • Use the imperative mood: write messages as if completing the sentence: "If applied, this commit will <subject>".
  • Explain the rationale behind the changes in the body: instead of detailing how the change was made (which is visible in the code), focus on why it is necessary.

About Conventional Commits​

Conventional Commits is a specification for adding human and machine-readable meaning to commit messages.
It is used to generate changelogs and automate versioning.

note

Since we use Changesets to handle versioning and changelogs, we do not require Conventional Commits. Instead, we focus on clear, structured messages that enhance readability.