Skip to content

feat: add conventional commit linting #686

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

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

Conversation

JasonLovesDoggo
Copy link
Member

@JasonLovesDoggo JasonLovesDoggo commented Jun 18, 2025

See issue for reasoning

Closes #316

Checklist:

  • Added a description of the changes to the [Unreleased] section of docs/docs/CHANGELOG.md
  • Added test cases to the relevant parts of the codebase
  • Ran integration tests npm run test:integration (unsupported on Windows, please use WSL)

@JasonLovesDoggo JasonLovesDoggo requested a review from Copilot June 18, 2025 01:51
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds conventional commit linting to enforce consistent commit messages across the project.

  • Introduces commitlint and husky dependencies and scripts in package.json
  • Provides commitlint.config.js and a Husky commit-msg hook to validate commits locally
  • Documents usage in the developer guide and sets up a GitHub Actions workflow to lint commits on push and PR

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
package.json Added @commitlint and husky dependencies and prepare script
docs/docs/developer/local-dev.md Added instructions for commit linting setup and format guide
commitlint.config.js New configuration file defining conventional commit rules
.husky/commit-msg Husky hook to run commitlint on each commit
.github/workflows/commits.yml CI workflow to validate commit messages on push and PR

check-spelling run (pull_request) for json/ccommits

Signed-off-by: check-spelling-bot <[email protected]>
on-behalf-of: @check-spelling <[email protected]>
@JasonLovesDoggo JasonLovesDoggo marked this pull request as ready for review June 18, 2025 02:08
@JasonLovesDoggo JasonLovesDoggo self-assigned this Jun 18, 2025
@JasonLovesDoggo JasonLovesDoggo requested a review from Xe June 18, 2025 02:08
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.

Adopt Conventional Commits
2 participants