This is a conventional-changelog preset for personal use, forked from conventional-changelog-angular.

Note: The latest version supports conventional-changelog v5 only. If you are using v4 and below, please use v0.3.0

Features and difference

• Different commit types (feat, fix, perf, chore, style, docs, refactor, test)
• Commit types renaming and sorting (order: 'Features', 'Bug Fixes', 'Styles', 'Refactor', 'Performance Improvements', 'Documentation', 'Test', 'Chores')
• Description scope (see below)
• Remove revert description

Usage

npm i -D conventional-changelog conventional-changelog-aaron-preset conventional-recommended-bump

npx conventional-changelog -o CHANGELOG.md -p aaron-preset -r 0

Format

<type>(<scope>): <commit message>
<BLANK LINE>
- commit description list
<BLANK LINE>
BREAKING CHANGE
- breaking changes description

scope, description scope and breaking change scope are optional.

Example

feat(app): revise the styles of the website

- adjust the height of the navbar
- change the theme color to `rgb(87, 13, 248)`

BREAKING CHANGE
- drop support for IE browser

In CHANGELOG.md:

# 2.0.0    (2023-10-20)


## **Features**

* revise the styles of the website ([f3a28e59](https://example.com/commit/f3a28e59))

    ### **Description**

    - adjust the height of the navbar
    - change the theme color to `rgb(87, 13, 248)`

    ### **BREAKING CHANGE**

    - drop support for IE browser

Check here to take a closer look in a real project.

Changelog

All notable changes to this project will be documented in this file. See commit-and-tag-version for commit guidelines.

1.1.0 (2024-03-19)

Features

• support scope (cfca78c)

1.0.4 (2023-10-20)

Bug Fixes

• fix errors during actions (455f135)

1.0.3 (2023-10-20)

Bug Fixes

• move all deps to devDependencies (0f78d34)

1.0.2 (2023-10-20)

Bug Fixes

• add missing variables (7adf2ea)

1.0.1 (2023-10-20)

Bug Fixes

• add missing await (669ad8e)

1.0.0 (2023-10-20)

Features

• migrate to support conventional-changelog v5 (feb6ce0)

BREAKING CHANGES

• Node >= 16 is required
• migrate all the files to esmodule. Commonjs is no longer supported

0.2.2 (2023-07-21)

Bug Fixes

• order the rest of types in commit groups sort (fcc6925)

0.2.1 (2023-07-19)

Bug Fixes

• wrong order for commit groups sort (ae3fda6)

0.2.0 (2023-07-19)

Features

• sort commit groups manually (7a8902a)

0.1.2 (2023-06-25)

Bug Fixes

• changelog format problems (ee95b7c)

0.1.1 (2023-06-25)

Features

• commit link (308138a)

0.1.0 (2023-06-25)

Features

• first commit 2d0d101