Skip to content

Commit convention

Jump to bottom
Airike Jaska edited this page Mar 21, 2025 · 9 revisions

Committing

  1. Before committing, a diff must be made for all files to be committed, and the diff must be reviewed. Specific environment files or other irrelevant information must not be committed.
  2. Each task must be in its own feature or fix branch.
    For example, for a GitHub issue like "Add new component #8," the branch would be feat/add-new-component-8. See more about branch naming below.
  3. Commit messages must follow the recommended standard of semantic-release: : https://github.com/semantic-release/semantic-release?tab=readme-ov-file#commit-message-format, based on Angular Conventions

Each commit message consists of a header, a body, and a footer.

<header>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

## Commit Message Header
<type>(<scope>): <short summary> #<issue number>
  │       │             │              │
  │       │             │              └─⫸ Issue number that has been created in GitHub
  │       │             │
  │       │             │
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: [component name]
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

Branch name

  • Branch name must consist: branch type, issue name and number.
  • Branch names must match in development and Figma (before the development process starts branch must be done, reviewed and merged in Figma)
  • Branch types:
    • feat - new features
    • bug - bug fixes for existing components and code
    • hotfix - urgent bug fixes for existing components and code released as quickly as possible.
  • Examples:
    • For a GitHub issue like "Add new component #8" the branch would be feat/add-new-component-8
    • For a GitHub issue/bug like "Mobile tabs alignment #10" the branch would be bug/mobile-tabs-alignment-10

Branch names

Type

Must be one of the following: build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) ci: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs) docs: Documentation only changes feat: A new feature fix: A bug fix perf: A code change that improves performance refactor: A code change that neither fixes a bug nor adds a feature test: Adding missing tests or correcting existing tests

Scope

The scope should be the name of the component affected (as perceived by the person reading the changelog generated from commit messages).

Summary

Use the summary field to provide a succinct description of the change: use the imperative, present tense: "change" not "changed" nor "changes" don't capitalize the first letter no dot (.) at the end

Commit Message Body

Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes". Explain the motivation for the change in the commit message body. This commit message should explain why you are making the change. You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.

Commit Message Footer

The footer can contain information about breaking changes and deprecations and is also the place to reference GitHub issues, Jira tickets, and other PRs that this commit closes or is related to. For example:

BREAKING CHANGE: <breaking change summary>
<BLANK LINE>
<breaking change description + migration instructions>
<BLANK LINE>
<BLANK LINE>
Fixes #<issue number>

or

DEPRECATED: <what is deprecated>
<BLANK LINE>
<deprecation description + recommended update path>
<BLANK LINE>
<BLANK LINE>
Closes #<pr number>

Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions. Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.

Examples

Commit message Release type
fix(pencil): stop graphite breaking when too much pressure applied

#123		 Fix Release
feat(pencil): add 'graphiteWidth' option

#321		 Feature Release
perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.

#333		 Breaking Release
(Note that the BREAKING CHANGE: token must be in the footer of the commit)

The task reference goes into the commit message header. Commit messages without a task reference are not allowed. If there's a need to do something for which there's no task, a task must be created.

Clone this wiki locally