bk-conventional-changelog

conventional-changelog Sport Heroes Group preset

Recommanded Git Commit Messages

• Use the past tense ("Added feature" not "Add feature")
• Use the imperative mood ("Moved cursor to.." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally

Acceptable commits

• Commit baseline: %icon% [%type%] (%scope%) %description%
  • %icon%, [%type%] and %description% are mandatory.
  • [%type%] must be wrapped into brackets. Example: [MOD].
  • (%scope%) is optional; If present, it must be wrapped into parenthesis. Example: (api).

Types of commits

• Consider starting the commit message with an applicable prefix:

  • ✅ [ADD] when adding new features.
  • 🔄 [MOD] when modifying code, removing files/code, upgrading dependencies, refactoring.
  • ✴️ [FIX] when fixing issues or bugs, plugging memory leaks.
  • 🔀 [TEST] when adding tests.
  • ☑️ [DOC] when adding/modifying documentation.
  • ⏩ [PUB] when bumping package version

• Examples of commits:

  • ✅ [ADD] (core) This is a brand new feature
  • 🔄 [MOD] (core) The new feature is now 10 times more efficient
  • ✴️ [FIX] (api) No longer writing bad commits
  • ☑️ [DOC] (npm) Spreading some love
  • ⏩ [PUB] Version is now 1.0.0

Change Log

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

2.0.3 (2025-03-21)

• 🔄 [MOD] Bump dependencies + set config as peerDep (3ae76ed)
• Bump handlebars from 4.1.2 to 4.5.3 (e101ea2)
• Bump lodash.template from 4.4.0 to 4.5.0 (df95664)

2.0.2 (2019-06-10)

🔄 Notable changes

• Dependencies: Upgrade dependencies (31b3cac))
• Miscellaneous: Handle security fix commit (c9c1f1a))

2.0.1 (2019-06-06)

🔄 Notable changes

• Miscellaneous: Handle security fix commit (c9c1f1a))

2.0.0 (2019-02-22)

☑️ Documentation

• Changelog: Recreated file from scratch (c0949f5 - TheOptimisticFactory)

✅ Features

• Core: Prepared core for open-sourcing (1d46912))

1.8.1 (2018-12-06)

🔄 Notable changes

• Usernames: Added new entries (ccec222 - TheOptimisticFactory)

1.8.0 (2018-07-09)

✅ Features

• Core: Discard release commit that aren't merges or lerna (342d54c - TheOptimisticFactory)

1.7.0 (2018-07-09)

✅ Features

• Dependencies: Bumped conventional-changelog-core to v3.0.0 (58c6079 - TheOptimisticFactory)

1.6.0 (2018-06-04)

✅ Features

• Core: Added trimming of all text fields (cb2dbc0 - TheOptimisticFactory)
• Core: Discard whitespaces at the start of a commit (568db58 - TheOptimisticFactory)

🔀 Testing

• Core: Added example of commit with trailing whitespaces (bdcc042 - TheOptimisticFactory)

🔄 Notable changes

• Dependencies: Bumped q version to v1.5.1 (2698d48 - TheOptimisticFactory)

1.5.2 (2018-04-19)

🔄 Notable changes

• Usernames: Added new entries (bed6c3c - TheOptimisticFactory)

1.5.1 (2018-02-12)

1.5.0 (2018-02-12)

✅ Features

• Core: Support of legacy merge commits (be7766f - TheOptimisticFactory)

1.4.2 (2018-02-12)

🔄 Notable changes

• Usernames: Added new entries (403022b - TheOptimisticFactory)

1.4.1 (2018-02-08)

✴️ Bug Fixes

• Core: Extended range of unicode-compatible characters (88993f9 - TheOptimisticFactory)

🔀 Testing

• Core: Made sure versioning commits are credited (86e4de9 - TheOptimisticFactory)

1.4.0 (2018-02-02)

✅ Features

• Core: Commits not following convention are now credited (5297c45 - TheOptimisticFactory)

🔄 Notable changes

• Usernames: Added new entries (45501a4 - TheOptimisticFactory)

1.3.2 (2017-12-15)

🔄 Notable changes

• Usernames: Added new entries (7b32d7e - TheOptimisticFactory)

1.3.1 (2017-11-03)

✴️ Bug Fixes

• Package: usernames table not being shipped on NPM (6def8a1 - TheOptimisticFactory)

1.3.0 (2017-10-31)

✅ Features

• Data: Added association table of comitter emails and usernames (409678c - TheOptimisticFactory)
• Preset: Added username in commit information (f1b94f2 - TheOptimisticFactory)

🔄 Notable changes

• Template: Commit template relies on username i/o committerName (95cd1e9 - TheOptimisticFactory)

1.2.1 (2017-10-30)

🔄 Notable changes

• Preset: Tweaked format to include both committer & merger names (f4e45ad - TheOptimisticFactory)

1.2.0 (2017-10-26)

✅ Features

• Preset: Added custom git log format (927d913 - TheOptimisticFactory)

1.1.0 (2017-10-26)

✅ Features

• Template: Commit message will now indicate committer identity (264f9f1 - TheOptimisticFactory)

1.0.2 (2017-08-25)

🔄 Notable changes

• Regex: Scope capture is now using a lazy match (9a13051 - TheOptimisticFactory)

1.0.1 (2017-08-11)

⏩ Versioning

• Miscellaneous: Version is now 1.0.1 (e3ea6cc - TheOptimisticFactory)

🔄 Notable changes

• Miscellaneous: Added NPM aliases for windows environment (85f8180 - TheOptimisticFactory)
• Miscellaneous: Enhanced header regex (6236a51 - TheOptimisticFactory)
• Miscellaneous: JsHint is now running on esversion 6 (e6483a2 - TheOptimisticFactory)

1.0.0 (2017-08-10)

⏩ Versioning

• Miscellaneous: Version is now 1.0.0 (9f86e30 - TheOptimisticFactory)

☑️ Documentation

• Miscellaneous: Adjusted convention documentation (9de28b1 - TheOptimisticFactory)

✅ Features

• Miscellaneous: Basic convention files (aeeb057 - TheOptimisticFactory)