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

ci: add conventional commits linter #850

Merged
merged 1 commit into from
Feb 7, 2024
Merged

ci: add conventional commits linter #850

merged 1 commit into from
Feb 7, 2024

Conversation

hf
Copy link
Contributor

@hf hf commented Feb 6, 2024

Adds a linter for commits and PRs to ensure that correct structure is observed. Certain directives are not compatible with this project:

  • Breaking changes are not allowed. Therefore PR titles or commit messages must not use the ! nor the BREAKING CHANGE directive in descriptions or commit messages.
  • The Release-As directive is not supported as it can break the release process.
  • For cleanliness, only a few conventional commit prefixes are allowed.

These are linted using a simple JavaScript script that runs on PRs and pushes.

Similar to:

Copy link
Contributor

@J0 J0 left a comment

Choose a reason for hiding this comment

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

Looks fine to me

@hf hf merged commit 1872886 into master Feb 7, 2024
3 checks passed
@hf hf deleted the hf/commit-linter branch February 7, 2024 10:04
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