Skip to content

Commit f0d734c

Browse files
committed
docs: description
1 parent b3db6c8 commit f0d734c

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
1-
# semantic-commit-generator
2-
A practical generator for creating standardized semantic commits. This convention adds human and machine readable meanings.
1+
# Semantic Commit Generator
2+
3+
A practical generator for creating standardized semantic commits.
4+
5+
This project can be appreciated in: https://jadsonlucena.github.io/semantic-commit-generator/
6+
7+
Semantic commit is a good practice that seeks to instruct how to create well-formed commits messages.\
8+
This facilitates the analysis of the project log by another team member or by automated tools.
9+
10+
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.

0 commit comments

Comments
 (0)