feat(linting): adding Commitlint ,Commitzen, Husky config#105
Merged
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
drtechie
approved these changes
Sep 30, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Implemented it for ECD-API
📋 Description
JIRA ID: N/A
GitHub Issue: Fixes PSMRI/AMRIT#80
This PR introduces commit message standardization for the Scheduler-API project by setting up *Commitlint, **Husky, and *Commitizen. The goal is to enforce a consistent commit message format across the repository to improve collaboration, readability, and enable automation (like changelogs and versioning) in the future.
These tools are now fully integrated:
• Commitlint enforces conventional commit message structure.
• Husky prevents non-compliant commits by using Git hooks.
• Commitizen provides an easy, interactive CLI for making properly formatted commits.
• GitHub Actions validate commit messages for all pull requests.
PS : @drtechie @Sneha6003 Implemented with the same standardization as for the UI repositories to ensure , clean code and well maintained code .
✅ Type of Change
ℹ️ Additional Information
• Added
commitlint.config.js with conventional commit rules.• Configured Husky to run Commitlint on every commit via
.husky/commit-msg .• Set up
Commitizen with configuration in package.json for interactive commit prompts.• Added GitHub Actions workflow
.github/workflows/commit-lint.yml to check commit messages on PRs.• Updated
package.json and package-lock.json with required dev dependencies: @commitlint/cli @commitlint/config-conventional commitizencz-conventional-changelogTesting & Validation
• Invalid commit messages are blocked locally with clear lint errors.
• Interactive commit flow works via npm run commit or npx cz .
• GitHub Actions workflow correctly fails PRs with non-compliant commit messages.
• No disruption to existing build or CI pipelines.
Screenshots