Clarkkkk/conventional-changelog-aaron-preset

A personal conventional-changelog preset

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.