generated from moja-global/Import-Me
-
Notifications
You must be signed in to change notification settings - Fork 67
Open
Labels
HacktoberfestPriority = MediumdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
What is the current documentation state?
Right now, the doc explains the idea around semantic commit messages. However, the whole context is not explained. We would like to add all of the semantic commit messages that we would like the contributor to utilize.
Where is this stated?
Why do you want to improve the statement?
No response
Proposed Statement
Here is the expected semantic commit message guideline that we would like to follow:
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, or test
feat: new feature for the user, not a new feature for the build script
fix: a bug fix
docs: changes to the documentation only
style: formatting, white-space, etc; no production code change
refactor: code change that does not fix a bug or add a feature, eg. renaming a variable
perf: code change that improves performance
test: adding missing tests, refactoring tests; no production code change
build: change that affects the build system or external dependencies (example scopes: gulp, npm)
ci: change to the CI configuration files and scripts
chore: change that does not modify src or test files
revert: reverts a previous commit
Additional context.
No response
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
HacktoberfestPriority = MediumdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers