Skip to content

[Proposal]: Adopt Conventional Commits & Commit-Linting #69

Description

@LMArantes

Problem
Commit messages are currently inconsistent—e.g. add manyyyyyyyy features 🤓, minor fixes ✌️, or repeated “format all files” messages.
While this works for solo hacking, it gets hard to:

  • generate changelogs or release notes,
  • bisect regressions,
  • review PRs at a glance,
  • onboard new contributors.

Wora is a young project with great potential and I absolutely love it so far. Standardizing commit messages is not about nit-picking; it’s about making future collaboration smoother and showing newcomers that the repo is well-organized and welcoming.

Suggested solution

  1. Adopt the Conventional Commits spec

    <type>[optional scope]: <description>
    
    [optional body]
    
    [optional footer(s)]
    

    Examples:

    • feat(player): add Last.fm scrobbling
    • fix(queue): preserve scroll while playing
    • chore(deps): bump howler to 2.2.4
  2. Add automated commit-linting

    • @commitlint/cli + commitlint-config-conventional
    • husky pre-commit hook to run commitlint
  3. Document the guideline

    • Brief section in CONTRIBUTING.md
    • A commit message template (.gitmessage) for convenience

Benefits: clear, searchable history, easier code reviews and reverts, automated releases & changelogs, and a more contributor-friendly project!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions