search

moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

Documentation📄: Improve `Commit message guideline` documentation #114

Open HarshCasper opened 3 years ago

HarshCasper commented 3 years ago

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?

https://docs.moja.global/en/latest/contributing/code_contribution_best_practices.html#commit-message-guidelines

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

dazzlerkumar commented 3 years ago

Hey, @HarshCasper , Can I work on this?

HarshCasper commented 3 years ago

Hey, @HarshCasper , Can I work on this?

Thanks for taking it up! Please let me know if you need any help or assistance.

SanjaySinghRajpoot commented 2 years ago

I would like to work on this issue.

HarshCasper commented 2 years ago

Hi @SanjaySinghRajpoot

@akashthedeveloper has shown an intent to work on this issue, over Slack. He can let us know if he still plans to work on this issue otherwise I will assign it to you.

akashthedeveloper commented 2 years ago

@HarshCasper I am ready to work on this issue, you can assign me.

harshita214 commented 1 year ago

Hii @HarshCasper I am interested to work on this issue. Can I be assigned this.