aron-conventional-commits

• Human-readable sentence case commits format
• Sometimes strict and sometimes loose commit formats
• Not only Monorepo but also single-package repositories
• Release rules are used for semantic analysis of semantic releases to bump versions automatically
• Groups are used to group changelogs
• This also applies to the conventional-changelog ecosystem

Commit Message Header

The header has a particular format that includes a Type, a Target, and a Summary:

Type(Target): Summary
  ┊     ┊
  ┊     └─⫸ Target: Workspace, Package or Role
  ┊
  └─⫸ Type: Bump, Feat, New, Perf, Add, Update, Improve, Fix, Depreciate, Drop, Docs, Upgrade, Revert, Example, Test, Refactor, Chore, Misc

• Type
  • Sentense case only
• Target
  • Sentense case only
  • Accept starting with Markdown characters ` * _ # ~
  • Can be omitted in one workspace
• Summary
  • Sentense case only
  • Accept starting with Markdown characters ` * _ # ~
  • No period at the end

Semver Commits

Such commits result in version bumps.

Patch

Perf Add Update Improve Fix Depreciate Drop Upgrade Revert Bump(Patch) Docs(README)

Bug Fixes

Changelog +0.0.1 A change to a system or product designed to handle a programming bug/glitch.

Fix: <summary>
Fix(Target): <summary>

_{🟢 Good for a monorepo}

Fix(CSS): HEX codes were incorrectly parsed as selectors
     ┊    ┊
     ┊    └─⫸ A brief description of the specific error
     ┊
     └─⫸ CSS is a workspace package

_{🔴 Bad for a monorepo}

Fix: Fix issues by extracting hex codes with strict rules
   ┊  ┊                 ┊
   ┊  ┊                 └─⫸ Describe the problem rather than the solution
   ┊  ┊
   ┊  └─⫸ Don't repeat the word `Fix` in Summary
   ┊
   └─⫸ Without a `(Target)`, the viewer cannot identify the participating workspace

Performance Upgrades

Changelog +0.0.1

Perf: <summary>
Perf(Target): <summary>

Example

Perf: Refresh cache when configuration changes

Additions

Changelog +0.0.1

Add: <summary>
Add(Target): <summary>

Example

Add(CSS): Option `.preference` for default theme

Improvements

Changelog +0.0.1

Improve: <summary>
Improve(Target): <summary>

Example

Improve(Home): Swap the order of **Feature** and **Pricing**

Updates

Changelog +0.0.1 Static content updates such as articles, news, about, profile, etc.

Update: <summary>
Update(Target): <summary>

Example

Update(Team): The member's job title changed

Upgrades

Changelog +0.0.1 Upgrade environment, system, dependencies, etc.

Upgrade: <summary>
Upgrade(Target): <summary>

Example

Upgrade(Compiler): Dependency `@master/css@^2.0.0`

Deprecations

Changelog +0.0.1 Alias: Drop Deprecate features, options, parameters, units, pages, etc.

Depreciate: <summary>
Depreciate(Target): <summary>

Example

Drop(Normal CSS): `--font-mono` `--font-sans` `--font-serif` CSS variables

Reversions

Changelog +0.0.1

Revert: ""


This reverts commit .

If you are using Git Graph extension for VSCode, Clicking Revert will automatically generate the following format:

Revert ""


This reverts commit .

Example

Revert "Fix(Repo): PeerDependencies -> Dependencies"


This reverts commit 779347237eef77e9137f88095e1fb813e5101c2b.

Update README _^Ungrouped

+0.0.1 The README.md of the NPM package can only be updated by releasing a new version. At this time, it's very convenient to trigger the patch through:

Docs(README): <summary>

Docs(README): Features section

It's reasonable to update README.md by bumping to the patch version because the documentation is part of this version.

Manual

+0.0.1 Manually bump a patch version due to special reasons.

Bump(Patch): <summary>

Example

git commit --allow-empty -m 'Bump(Patch): `+0.0.1`'

Minor

Feat New Bump(Minor)

New Features

Changelog +0.1.0 Alias: New

Feat: <summary>
Feat(Target): <summary>

Example

New(Syntax): A new shorthand `WxH` for `width:` and `height:`

Manual

+0.1.0 Manually bump a minor version due to special reasons.

Bump(Minor): <summary>

Example

git commit --allow-empty -m 'Bump(Minor): `+0.1.0`'

Major

Bumping to the next major version should be triggered manually by the manager rather than relying on a flag in a given commit.

_Format

Bump(Major): <summary>

No clear motivation for <summary> yet? Hit Version or the next version, like v2.0.0.

_{🟢 Good for a monorepo}

git commit --allow-empty -m 'Bump(Major): Master CSS v2.0'

This is just a commit used to trigger version analysis, don't be obsessed with changes in files, so add --allow-empty

Other Commits

Trivial routine commits include test cases, examples, and environment configurations.

Docs Tests Example Chore Misc

Documentation

Docs: <summary>
Docs(Target): <summary>

Example

Docs(CSS): Initialize Master CSS with custom configuration

Tests

Test: <summary>
Test(Target): <summary>

Example

Test(Syntax): Check CSS rules for `WxH` output

Examples

Example: <summary>
Example(Target): <summary>

Example

Example(Next.js 13): Update to layouts RFC

Miscellaneous

• Alias: Chore or no prefix

Misc: <summary>
Misc(Target): <summary>
<summary>

Example

Chore: Update README.md

I prefer no prefix; having to keep prefixing every frequent trivial item is annoying, and marking trivial items doesn't make much sense.

_{🟢 Better day-to-day development experience}

Update README.md