Skip to content

Commit 6e898dd

Browse files
committed
docs: commit message header
1 parent b777780 commit 6e898dd

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,19 @@ The commit message must be in the present imperative. This tells someone what th
2323

2424
- The confirmation message header cannot exceed the 50 character limit!
2525
- If there are any technical details that cannot be expressed in these strict size restrictions, place them on the body.
26-
- The footer must contain the necessary references and details of changes that cause interruption, if any.
26+
- The footer must contain the necessary references and details of changes that cause interruption, if any.
27+
28+
29+
## Commit Message Header
30+
31+
```
32+
<type>[optional scope][optional !]: <short summary>
33+
│ │ | │
34+
│ │ | └─⫸ Summary in present tense. Not capitalized. No period at the end
35+
│ │ |
36+
| | └─⫸ The exclamation mark must be used to draw attention to significant changes
37+
| |
38+
│ └─⫸ Describes a section of the code base that provides additional contextual information
39+
40+
└─⫸ Commit Type: build|ci|chore|docs|feat|fix|improvement|perf|refactor|revert|style|test|other
41+
```

0 commit comments

Comments
 (0)