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

Explore adding commitizen as a precommit hook #2935

Open
Tracked by #2677
six7 opened this issue Jul 1, 2024 · 1 comment
Open
Tracked by #2677

Explore adding commitizen as a precommit hook #2935

six7 opened this issue Jul 1, 2024 · 1 comment

Comments

@six7
Copy link
Collaborator

six7 commented Jul 1, 2024

Let's integrate commitizen as a precommit hook in the plugin codebase: https://commitizen-tools.github.io/commitizen/

@six7 six7 mentioned this issue Jul 1, 2024
@six7 six7 moved this from 📥 Triage to ⚙️ Shaping Engineering in Tokens Studio for Figma Roadmap Jul 8, 2024
@macintoshhelper
Copy link
Contributor

Pros

  • Consistent commit messages across different developers
  • Can help with semantic versioning and possibly be a better alternative to changesets
  • Makes sure there is extra context on historical changes

Cons

  • conventional-changelog might conflict with changesets
  • Requires Python/Homebrew and requires contributors to have it installed as a global system package – extra onboarding steps
  • Breaks muscle memory of git commit -m

Suggested Actions

  • Discussion around whether to
    • Have commitizen as an optional/recommended commit step
    • Require commitizen with Husky
    • Use a commit message convention/format
  • Recommend including issue numbers in commits
  • Recommend prefixing commits with fix/feat/test/ci, etc to use as a tag for the context of the commit – e.g. Angular Commit Message Format https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format

Amount of Time to Implement: Small (mainly discussion, Husky is already used)

Resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ⚙️ Shaping Engineering
Development

No branches or pull requests

3 participants