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

Add Comprehensive Guide to Conventional Commits for Contributors.md ✨ #1508

Closed
Nishitbaria opened this issue Aug 7, 2023 · 3 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation gssoc GirlScript Summer of Code participants level1 Addition of new links/categories or doing any small task (e.g fixing typos) 🚀 ready

Comments

@Nishitbaria
Copy link
Contributor

Description:
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.

Current Situation:
Currently, our project lacks specific guidelines for writing commit messages, leading to inconsistent and unclear commit messages. This can make it challenging for contributors and maintainers to review changes and understand the context of each commit.

Proposed Solution:
We propose adding a section in the CONTRIBUTION.md file that outlines the Conventional Commits guideline. This section should cover the basic structure and rules for writing commit messages following the Conventional Commits standard.

Benefits:
By implementing the Conventional Commits guideline, our project will enjoy the following benefits:

  1. 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.
  2. Automated Release Notes: Conventional Commits can be utilized to generate automated release notes, making the release process more efficient and less error-prone.
  3. Improved Collaboration: The standardized commit messages will enhance communication and collaboration among contributors and maintainers, fostering a healthier development community.
  4. 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:

  1. Add a new section titled "Conventional Commits Guideline" in the CONTRIBUTION.md file.
  2. Provide a brief overview of Conventional Commits and its importance in our project.
  3. Outline the standard commit message format following the Conventional Commits rules.
  4. Provide examples of well-formatted commit messages for various types of changes (e.g., feature addition, bug fix, documentation update, etc.).
  5. Mention any additional project-specific guidelines or conventions related to commit messages, if applicable.
@github-actions
Copy link

github-actions bot commented Aug 7, 2023

To reduce notifications, issues are locked. Your issue will be unlocked when we add the label, 🚀 ready.

@github-actions
Copy link

github-actions bot commented Aug 7, 2023

Hello Nishitbaria!
Thank you for raising this issue! 😊 Your contribution is valuable to us! 😊

Please make sure to follow our Contributing Guidelines. 💪🏻

Our review team will carefully assess the issue and reach out to you soon! 😇
We appreciate your patience!

@github-actions github-actions bot locked and limited conversation to collaborators Aug 7, 2023
@CBID2 CBID2 removed the 🔒 locked label Aug 7, 2023
Repository owner unlocked this conversation Aug 7, 2023
@CBID2
Copy link
Collaborator

CBID2 commented Aug 7, 2023

That's a great idea @Nishitbaria! :)

@CBID2 CBID2 added documentation Improvements or additions to documentation gssoc GirlScript Summer of Code participants 🚀 ready level1 Addition of new links/categories or doing any small task (e.g fixing typos) labels Aug 7, 2023
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 gssoc GirlScript Summer of Code participants level1 Addition of new links/categories or doing any small task (e.g fixing typos) 🚀 ready
Projects
None yet
Development

No branches or pull requests

2 participants