Skip to content

Implement Conventional Commits for the project #2

@leftkats

Description

@leftkats

[Chore] Implement Conventional Commits for the project

Description

As the project grows, having a standardized commit message format becomes essential for readability and automation (like automated changelogs).

Proposed Standard

We should follow the Conventional Commits specification:
type(scope): description

Common types:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • refactor: A code change that neither fixes a bug nor adds a feature

Tasks

  • Update the CONTRIBUTING.md (if exists) or README.md to mention this standard.

Benefit

Makes the git history much easier to navigate and allows tools like git-cliff to categorize changes automatically.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions