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

build: add commitlint and upgrade husky #86

Merged
merged 1 commit into from
Aug 27, 2024
Merged

build: add commitlint and upgrade husky #86

merged 1 commit into from
Aug 27, 2024

Conversation

chrisalley
Copy link
Collaborator

Use conventional commits in this project: https://www.conventionalcommits.org/en/v1.0.0/

Copy link
Contributor

@tagliala tagliala left a comment

Choose a reason for hiding this comment

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

I'm not a huge fan of the js/angular approach for commit titles (I prefer https://cbea.ms/git-commit/#seven-rules and the 50 chars rule for commit title) but I understand that some tools to generate changelogs and large teams would have a huge benefit from tags and breaking changes meta in the title (unless you forget !)

@chrisalley
Copy link
Collaborator Author

Thanks for the review. I've been trialing this format across my JavaScript projects, but we can leave it off Pundit Matchers.

Is there a npm package and/or gem to enforce the 7 rules approach?

@chrisalley chrisalley merged commit 7bf2702 into main Aug 27, 2024
3 checks passed
@chrisalley chrisalley deleted the commitlint branch August 27, 2024 06:11
@tagliala
Copy link
Contributor

Is there a npm package and/or gem to enforce the 7 rules approach?

Not that I know, but since this is a JS library it makes sense. It looks like commitlint allows to specify rules, but I think it's not worth

PS: It appears that dependabot.yml needs a change to meet commit message requirement, as per https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#commit-message

tagliala added a commit that referenced this pull request Aug 27, 2024
This is an attempt to make Dependabot meet conventional commit format

Refs: #86
tagliala added a commit that referenced this pull request Aug 27, 2024
This is an attempt to make Dependabot meet conventional commit format.
Use `build: ` prefix because it is the one used by commitlint itself

Refs: #86
tagliala added a commit that referenced this pull request Aug 27, 2024
This is an attempt to make Dependabot meet conventional commit format.
Use `build: ` prefix because it is the one used by commitlint itself

Refs: #86
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.

2 participants