@datability/8ui

v1.2.3

Published

25 days ago

We have very precise rules over how our Git commit messages must be formatted. This format leads to **easier to read commit history** and makes it analyzable for changelog generation.

0High
0Medium
0Low

knighth

codenuk

Commit Message Format

We have very precise rules over how our Git commit messages must be formatted. This format leads to easier to read commit history and makes it analyzable for changelog generation.

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

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

The header is mandatory and must conform to the Commit Message Header format.

The body is mandatory for all commits except for those of type "docs". When the body is present it must be at least 20 characters long and must conform to the Commit Message Body format.

The footer is optional. The Commit Message Footer format describes what the footer is used for and the structure it must have.

Commit Message Header

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
  │                          elements|forms|http|language-service|localize|platform-browser|
  │                          platform-browser-dynamic|platform-server|router|service-worker|
  │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|
  │                          devtools
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

Type

Must be one of the following:

| Type | ความหมาย | Version ที่ bump | | ------------ | ------------------------------ | ---------------- | | feat | เพิ่ม feature ใหม่ | minor | | feat! | feature ใหม่ + breaking change | major | | fix | แก้ bug | patch | | perf | ปรับ performance | patch | | refactor | ปรับโค้ด (behavior เดิม) | ❌ (ไม่ bump) | | docs | เอกสาร | ❌ | | test | test | ❌ | | build | build / deps | ❌ | | ci | CI/CD | ❌ |

Scope

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

The following is the list of supported scopes:

| Scope | ใช้เมื่อ | | ---------- | ----------------------------- | | ui | UI component | | page | page / route | | layout | layout | | form | form logic | | state | global state (redux, zustand) | | hook | custom hook | | api | frontend api call | | auth | login / permission | | theme | theme / style | | style | css / scss | | i18n | localization | | router | routing | | asset | image, icon | | build | vite / next config | | perf | performance | | test | frontend test |

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 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>

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 brief 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.

Revert commits

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit.

The content of the commit message body should contain:

information about the SHA of the commit being reverted in the following format: This reverts commit <SHA>,
a clear description of the reason for reverting the commit message.

Example commit

fix: handle expired token → patch feat: add profile api → minor

feat: remove legacy login \n BREAKING CHANGE: remove legacy logic → major

refactor: simplify join logic → no releasee ci: update github actions → no releasee

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme