chore: add husky and commitlint for improved commit message linting #66
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces comprehensive commit message linting infrastructure to enforce Conventional Commits standards, improving consistency and enabling automated releases. The changes add both local pre-commit validation via Husky hooks and CI-based validation through GitHub Actions.
Changes:
- Adds commitlint and husky packages with configuration for Conventional Commits enforcement
- Implements local Git hooks for commit message validation and pre-commit testing
- Creates GitHub Actions workflow for automated commit linting in CI
- Updates documentation to clarify commit message format requirements and provide examples
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Adds @commitlint/cli, @commitlint/config-conventional, and husky dependencies; adds prepare script for husky |
| package-lock.json | Updates lockfile with new dependencies and bumps version from 0.5.0 to 0.5.1 |
| commitlint.config.js | Basic commitlint configuration extending conventional config |
| .husky/commit-msg | Git hook to validate commit messages using commitlint |
| .husky/pre-commit | Git hook to run tests before each commit |
| .github/workflows/commitlint.yml | CI workflow for validating commit messages on push and PRs |
| .github/copilot-instructions.md | Adds commit message formatting guidelines for AI assistance |
| .github/CONTRIBUTING.md | Expands commit guidelines with detailed Conventional Commits documentation |
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Morgy93
force-pushed
the
streamline-commits
branch
from
ecd3695 to
d55c66f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces automated commit message linting to enforce the Conventional Commits standard, both locally and in CI, and updates documentation to clarify the commit message policy. The changes ensure that all contributors follow a consistent commit message format, which helps automate releases and improves project maintainability.
Commit Linting Automation:
.github/workflows/commitlint.yml) to automatically lint commit messages on every push and pull request, ensuring compliance with Conventional Commits.commitlintand its conventional config as development dependencies inpackage.json, and sets up a basic configuration incommitlint.config.js. [1] [2] [3]commit-msghook and runs tests on pre-commit, ensuring that invalid commit messages are caught before reaching the repository. [1] [2] [3]Documentation Updates:
.github/CONTRIBUTING.mdand.github/copilot-instructions.mdto clarify the required Conventional Commits format, providing examples and specifying allowed commit types. [1] [2]