DOC: Guidelines for git commit messages in Contribution.md📃
Closed this issue · 3 comments
What's wrong with the existing documentation
As a project that values clear and consistent commit messages, we should adopt the Conventional Commits guideline to enhance our development workflow and improve collaboration among contributors. Conventional Commits provide a well-defined specification for writing commit messages, making it easier to understand the purpose and impact of each commit.
Screenshots
Benefits:
By implementing the Conventional Commits guideline, our project will enjoy the following benefits:
Clear and Meaningful Commit Messages: Contributors will be encouraged to provide descriptive commit messages that explain the purpose and changes introduced in each commit, making it easier for everyone to follow the development history.
Automated Release Notes: Conventional Commits can be utilized to generate automated release notes, making the release process more efficient and less error-prone.
Improved Collaboration: The standardized commit messages will enhance communication and collaboration among contributors and maintainers, fostering a healthier development community.
Easier Changelog Generation: Following the Conventional Commits specification will simplify the generation of changelogs, which is crucial for users and stakeholders to track project changes.
Proposed Changes:
Add a new section titled "Conventional Commits Guideline" in the CONTRIBUTION.md file.
Provide a brief overview of Conventional Commits and its importance in our project.
Outline the standard commit message format following the Conventional Commits rules.
Provide examples of well-formatted commit messages for various types of changes (e.g., feature addition, bug fix, documentation update, etc.).
Mention any additional project-specific guidelines or conventions related to commit messages, if applicable.
Add ScreenShots
N/A
Record
- I agree to follow this project's Code of Conduct
- I'm a GSSOC'23 contributor
- I want to work on this issue
Thank you for raising an issue. We will investigate into the matter and get back to you as soon as possible.
Please make sure you have given us as much context as possible.
Hey @MonalikaPatnaik, could you please assign me this issue? As we know, GSSoC will be ending in two days. I'm trying my best to maximize my contributions, as I want to help make the project as good as possible. Thank you!
👋 @Nishitbaria This issue is closed.