Skip to main content

Version Control

Commit

Message

  1. Use two separate messages for multi-line tasks:
  • First message includes a general overview describing the commit.
  • Second message includes detailed information about the commit - described in the table below.
  1. Use Summary: as header for blocks listing commit changes.

  2. Use Changelog: as header for blocks listing changes to include in CHANGELOG.md file.

  3. Each commit change message should start with a capital letter after its prefix.

  4. Add type prefix for each commit change message.

Change types

PrefixDescription
breaking:Commit includes changes that could break previous API.
chore:Tasks and coding activity.
deprecatedRemove outdated or refactored code block or package.
docsAdded, updated or deprecated documentation entries.
enhancementImprove or expand on existing functionality or feature.
fixFix a bug or a regression.
refactorUpdate existing code; no new functionality added.
updateReplace existing code with new API or change functionality.
upgradeIncluding package dependencies, db schema, scripts, etc.