Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation📄: Improve Commit message guideline documentation #114

Open
HarshCasper opened this issue Oct 1, 2021 · 6 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Priority = Medium

Comments

@HarshCasper
Copy link
Member

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

@HarshCasper HarshCasper added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Priority = Medium labels Oct 1, 2021
@dazzlerkumar
Copy link

Hey, @HarshCasper , Can I work on this?

@HarshCasper
Copy link
Member Author

Hey, @HarshCasper , Can I work on this?

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

@SanjaySinghRajpoot
Copy link
Contributor

I would like to work on this issue.

@HarshCasper
Copy link
Member Author

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
Copy link

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

@harshita214
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Priority = Medium
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants