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 commitizen to make it easier to follow the Commit Message Guidelines #6659

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

rikhall1515
Copy link

@rikhall1515 rikhall1515 commented Apr 15, 2024

Description

This change makes it easier to follow the conventional commits standard by
automatically using the commitizen CLI whenever you execute git commit (no -m flag).

Validation

I ran git commit, used the CLI, and commitizen worked as it should.

Related Issues

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npx turbo format to ensure the code follows the style guide.
  • I have run npx turbo test to check if all tests are passing.
  • I have run npx turbo build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

This change makes it easier to follow the conventional commits standard by automatically using the
commitizen CLI whenever you execute git commit (no flags).
@rikhall1515 rikhall1515 requested review from a team as code owners April 15, 2024 11:20
Copy link

vercel bot commented Apr 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Apr 26, 2024 7:20pm

@rikhall1515 rikhall1515 changed the title ci(commit): Add commitizen and commitlint Add commitizen and commitlint to make it easier to follow the Commit Message Guidelines Apr 15, 2024
CONTRIBUTING.md Outdated Show resolved Hide resolved
commitlint.config.ts Outdated Show resolved Hide resolved
Commitlint config should not be too strict.
@rikhall1515
Copy link
Author

rikhall1515 commented Apr 17, 2024

I'm honestly debating if I should even keep commitlint in this change.

I've changed the config so that it's not terribly strict about the rules. It will allow
sentence case, lower case, and anything in-between (in case of accidental typos).

More strictness just leads to a terrible developer experience because there is no
easy way of integrating linting into the commit message file (that works on all IDEs).
If you close the file, have it be linted, and then it fails; now you must redo the whole
thing. I've checked and there isn't an easy way around that.

Also, you get 80% of the result anyway if you just use git commit and let commitizen
do most of the work. Commitlint at this point only exists to prevent cases where the user
intentionally avoids commitizen.

@ovflowd
Copy link
Member

ovflowd commented Apr 21, 2024

lso, you get 80% of the result anyway if you just use git commit and let commitizen
do most of the work. Commitlint at this point only exi

I feel that if we are so permissive for commit messages, we lose the reasoning behind CommitLint, no?

I do believe adding Semantic Versioning would be great tho!!

@rikhall1515
Copy link
Author

lso, you get 80% of the result anyway if you just use git commit and let commitizen
do most of the work. Commitlint at this point only exi

I feel that if we are so permissive for commit messages, we lose the reasoning behind CommitLint, no?

I do believe adding Semantic Versioning would be great tho!!

Yeah you're right, I'll update the PR so it's just commitizen in that case.

@rikhall1515 rikhall1515 changed the title Add commitizen and commitlint to make it easier to follow the Commit Message Guidelines Add commitizen to make it easier to follow the Commit Message Guidelines Apr 21, 2024
Copy link
Member

@araujogui araujogui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for you first contribution!

Signed-off-by: Rikard Hallberg <webbman3@gmail.com>
@aymen94
Copy link
Member

aymen94 commented Apr 26, 2024

LGTM, @rikhall1515 thanks for contribution.

Signed-off-by: Rikard Hallberg <r15.hallberg@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants