chore(coderabbit): add labeling instructions and code guidelines - #10
Merged
Conversation
Schema-validated .coderabbit.yaml with assertive review profile, Python-specific tool tuning (ruff on, flake8/pylint off), security scanners (semgrep, trufflehog, gitleaks, trivy, zizmor), path instructions for telemetry PII, type safety, CI workflow security, and the zero-new-runtime-deps policy gate.
Wire CONTRIBUTING.md and AGENTS.md into knowledge_base.code_guidelines so CodeRabbit enforces project standards (zero-deps policy, agent conventions) automatically during reviews. Add labeling_instructions to map the four existing repo labels to conventional commit prefixes for accurate suggestions.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a zero-new-bundled-deps runtime dependency policy to CONTRIBUTING.md and updates .coderabbit.yaml to auto-label dependency-related PRs, allow an optional scope in conventional-commit titles, and enable knowledge-base learning from CONTRIBUTING.md and AGENTS.md. ChangesDependency Policy and Review Automation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.coderabbit.yaml:
- Line 93: The PR title rule in the requirements field currently enforces
"type(scope): description", which conflicts with your label mapping that expects
prefixes like "feat:", "fix:", and "docs:"; update the requirements value (the
requirements key in .coderabbit.yaml) to a pattern that matches your label
mapping—e.g., require "feat: description | fix: description | docs: description"
or a conventional-commit pattern that allows both "type: description" and
"type(scope): description" so that titles with "feat:", "fix:", and "docs:" pass
without pre-merge warnings.
In `@CONTRIBUTING.md`:
- Around line 31-34: Update the CONTRIBUTING.md phrasing that currently reads
"Use the standard library, or hand-roll what you need, rather than adding a
package" to avoid encouraging custom implementations; change it to instruct
contributors to prefer the standard library or existing internal modules first
and to request an approved exception from a maintainer before adding a new
dependency or implementing a bespoke solution, ensuring the policy still conveys
the zero-new-bundled-deps rule and the approval path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 5d759867-f8fc-41b4-9166-25d031b307fc
📒 Files selected for processing (3)
.coderabbit.yamlAGENTS.mdCONTRIBUTING.md
…cy wording Address CodeRabbit review comments: - type(scope)?: description — scope is optional in conventional commits - CONTRIBUTING.md: prefer stdlib/internal modules; request exception rather than hand-rolling, to guide contributors toward the approval path
The merge from main into this branch reverted the labeling_instructions and knowledge_base.code_guidelines additions. Restore them.
Contributor
|
Actionable comments posted: 0 |
pyproject.toml touched to satisfy branch protection required status checks (check, test, release-validate) that only run when tracked paths change.
Contributor
|
Actionable comments posted: 0 |
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
1 participant
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.
Summary
knowledge_base.code_guidelinespointing toCONTRIBUTING.mdandAGENTS.mdso CodeRabbit enforces project standards (zero-new-bundled-deps policy, agent conventions) automatically during reviews without needing to repeat them inpath_instructionslabeling_instructionsmapping the four existing repo labels (enhancement,bug,documentation,dependencies) to conventional commit prefixes for accurate, consistent label suggestionsTest plan
feat:PR showenhancement,fix:showsbug, etc.Summary by CodeRabbit
Documentation
Chores