anarchy-ai / anarchy-ai/LLM-VM

Adoption of Conventional Commits

Ouverte
#208 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
feat/enhancement wontfix
Langage dominant
Python
Étoiles
490
Forks
139
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Hello 👋 ,

This issue is opened to propose the adoption of ["Conventional Commits"](https://www.conventionalcommits.org/en/v1.0.0/) in our project to make our development process more organized and understandable. Conventional Commits provide a standardized way of writing commit messages, which greatly benefits version management, release notes, and automation for a project.

Proposal:
We are considering the following steps to embrace the usage of Conventional Commits in our project:

Add a Guideline: Create a CONTRIBUTING.md or a similar guideline file that explains how contributors should use Conventional Commits.

Define Rules: Specify the Conventional Commits rules that will be used in the project and add them to the README or CONTRIBUTING.md file.

Automation Integration: Integrate tools that automatically enforce the usage of Conventional Commits, such as Commitizen or Husky.

Update Documentation: Update the project's documentation to encourage and educate contributors on the advantages of using Conventional Commits.

Reasons:
The usage of Conventional Commits offers several advantages for our project:

Improved Version Management: Conventional Commits facilitate the generation of clear and organized release notes, making it easier for users to understand what has changed in each release.

Automation Benefits: They enable us to automate tasks like generating changelogs and version bumping, reducing the manual effort required in our release process.

Clarity and Traceability: Commit messages become more descriptive and follow a consistent pattern, which improves the clarity of the development history and makes it easier to trace changes.

Integration with Issue Tracking: Conventional Commits often integrate seamlessly with issue tracking systems, enhancing our project management capabilities.

By adopting Conventional Commits, we can streamline our development process, enhance communication among contributors, and provide a more transparent view of our project's evolution.

Please consider this proposal, and we eagerly await your feedback.

Thank you.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.