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

Switch from SemVer PR labels to Conventional Commits #21

Merged
merged 2 commits into from
Oct 11, 2024

Conversation

jcouball
Copy link
Member

Use Conventional Commits to track what types of changes are being made.

This will ensure that all commits in this project adhere to a standardized format, which will help streamline collaboration and automate release workflows.

  1. Add a git commit-msg hook to validate commit messages as they are made
  2. Add a GitHub workflow to validate that all commits in a PR conform to conventional commits
  3. Remove the requirement for semver pr labels

The GitHub branching rules should be changed to require the conventional commit workflow to succeed before PRs can be merged. This ensures that all developer commits are conventional commits. The GitHub merging rules should be changed to ensure that ONLY rebase merges are allowed. This ensures that unvalidated commit messages from merge commits or sqash commits are not added to the release branch.

1. Add a git commit-msg hook to validate commit messages as they are made
2. Add a GitHub workflow to validate that all commits in a PR conform to conventional commits
Do not require semver pr labels since we are switching to using conventional commits instead.
Copy link

codeclimate bot commented Oct 11, 2024

Code Climate has analyzed commit 6b636c5 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 100.0% (0.0% change).

View more on Code Climate.

@jcouball jcouball merged commit c9aed1f into main Oct 11, 2024
12 checks passed
@jcouball jcouball deleted the enforce_conventional_commits branch October 11, 2024 15:11
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.

1 participant