moja-global / moja-global/moja_global_docs
Documentation📄: Improve `Commit message guideline` documentation
Open
@akashthedeveloper is already working on this.
Since Mar 13, 2022.
documentation
good first issue
Hacktoberfest
Priority = Medium
- Dominant language
- Shell
- Stars
- 35
- Forks
- 64
- PR merge metrics
- No merged PRs in 30d
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.