Skip to content

Commit b777780

Browse files
committed
docs: commit message format
1 parent f0d734c commit b777780

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
@@ -8,4 +8,19 @@ Semantic commit is a good practice that seeks to instruct how to create well-for
88
This facilitates the analysis of the project log by another team member or by automated tools.
99

1010
Each commit must be atomic. As one of the foundations of continuous integration (CI), this methodology provides that each new functionality or change is always available and properly documented, with this, errors can be detected in advance.\
11-
The commit message must be in the present imperative. This tells someone what the commit application will do, instead of what you did.
11+
The commit message must be in the present imperative. This tells someone what the commit application will do, instead of what you did.
12+
13+
14+
## Commit Message Format
15+
16+
```
17+
<header>
18+
<BLANK LINE>
19+
[optional body]
20+
<BLANK LINE>
21+
[optional footer(s)]
22+
```
23+
24+
- The confirmation message header cannot exceed the 50 character limit!
25+
- 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.

0 commit comments

Comments
 (0)