-
Notifications
You must be signed in to change notification settings - Fork 14
chore(ci): add commitlint config rules #225
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
Conversation
WalkthroughA new commitlint configuration file has been added. This configuration extends the conventional commitlint rules, enforces a maximum header and body line length of 80 characters, and introduces ignore rules to exempt Dependabot-generated commits from linting. The configuration is exported as the default export from the file. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant CommitLint
Developer->>CommitLint: Submit commit message
alt Dependabot commit (matches ignore rules)
CommitLint-->>Developer: Skip linting
else Non-Dependabot commit
CommitLint->>CommitLint: Check header and body line lengths (max 80 chars)
alt Passes rules
CommitLint-->>Developer: Lint passes
else Fails rules
CommitLint-->>Developer: Lint fails with error
end
end
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
8745cc1 to
867fee6
Compare
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (4)
commitlint.config.mjs (4)
3-4: Consider usingextendsrather than spreading the base config
While spreadingconventionalworks, it may inadvertently pull in internal keys. A more idiomatic approach is:export default { extends: ["@commitlint/config-conventional"], rules: { /* ... */ }, ignores: [ /* ... */ ] };This is clearer and prevents unexpected inheritance.
6-7: Revisit the 80-character body limit
Enforcing an 80-char max on commit bodies is stricter than the conventional default (100–120). Confirm with your team that this won’t break existing workflows or tooling.
13-13: Extend the Dependabot bump regex if needed
Your current pattern coverschore(deps): bumpandchore(deps-dev): bump. If you also receive lockfile bumps, consider:/(^chore\(deps(-dev)?\): bump |^chore\(lockfile\): )/Adjust to fit your repo’s conventions.
15-15: Add a trailing newline
POSIX and many linters expect files to end with a newline.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
commitlint.config.mjs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (csharp)



Summary by CodeRabbit