-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.gitmessage
More file actions
18 lines (15 loc) · 1.37 KB
/
.gitmessage
File metadata and controls
18 lines (15 loc) · 1.37 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
## Conventional commits format
#
# The commit contains the following structural elements, to communicate intent to the consumers of your library:
#
# 1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
# 2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
# 3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
# 4. types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
# 5. footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
#
# Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE).
# A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.