Conventional Commits

lastmod 2021-06-02created 2021-06-024 edits

A specification for adding meaning to commit messages that both humans and machines can understand.

Overview

The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history, which makes it easier to write automated tools on top of. This convention dovetails with Semantic Versioning (Sementic Versioning) by describing the features, fixes, and breaking changes made in commit messages.

Structure

The commit message should be structured as follows:

<타입>[적용 범위(선택 사항)]: <설명>

[본문(선택 사항)]

[꼬리말(선택 사항)]

See also

• Semantic Versioning

Favorite site

• Conventional Commits web site
  • Conventional Conventional Commits web site (ko)
• Automating CHANGELOG and Semantic Versioning with Conventional Commits
  • Semantic Versioning (SemVer) is an easy concept to understand, but versioning by hand is not easy because you need to know what has changed in the meantime
  • Let's automate semantic versioning and the CHANGELOG with Conventional Commits => semantic-release was born
  • Easy to apply regardless of language with GitHub Actions