-
Notifications
You must be signed in to change notification settings - Fork 481
Add Coderabbit config #710
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
Add Coderabbit config #710
Conversation
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
WalkthroughAdds a new Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer/Repo
participant CR as CodeRabbit (config)
participant Tools as Linters/Scanners
participant Review as Automated Review Output
rect rgba(135,206,250,0.12)
Dev->>CR: Push PR with `.coderabbit.yaml`
CR->>Tools: Trigger enabled tools (ruff, yamllint, markdownlint, gitleaks, osvScanner)
Tools-->>CR: Analysis results
end
rect rgba(144,238,144,0.12)
CR->>Review: Generate auto_review (auto_incremental_review)
Note right of Review: sequence_diagrams enabled → include diagrams
Review-->>Dev: Post review status, labels, and checks (pre-merge warnings)
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
PoemPoem generation is disabled ( Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
✨ 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
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 (5)
.coderabbit.yaml (5)
95-101: Fixture example uses @fixture without import; prefer @pytest.fixture for clarity.As written, it may confuse contributors unless they import fixture explicitly. Recommend using the canonical decorator.
Apply this diff:
- - Pytest fixtures should define the name argument when applying the pytest.fixture decorator. The fixture - function being decorated should be named using the `fixture_` prefix, using snake_case. Example: - @fixture(name="my_fixture") + - Pytest fixtures should define the `name` argument when applying the `@pytest.fixture` decorator. The fixture + function being decorated should be named using the `fixture_` prefix, using snake_case. Example: + @pytest.fixture(name="my_fixture") def fixture_my_fixture(): pass
131-135: “external” label rule hard-codes a team; use author_association to avoid org/team drift.Team names and membership change; GitHub exposes author_association (OWNER, MEMBER, COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, NONE). Suggest basing guidance on that.
Apply this diff:
- - label: external - instructions: >- - Apply this label when the PR was submitted by someone who is not a member of the @NVIDIA/agentiq-developers - GitHub team. + - label: external + instructions: >- + Apply this label when the PR author is not an organization OWNER or MEMBER (i.e., author_association is + COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, or NONE).
33-33: Consider enabling incremental reviews to reduce noise on subsequent pushes.auto_incremental_review: false disables incremental passes; enabling it usually shortens feedback cycles on active PRs.
Apply this diff:
- auto_incremental_review: false + auto_incremental_review: true
25-25: Tweak title guidance grammar and be explicit about length.Small clarity improvement; no behavior change.
Apply this diff:
- requirements: "Title should be concise, and descriptive, and use imperative mood (max ~72 chars)." + requirements: "Title should be concise, descriptive, and use imperative mood (≤72 characters)."
8-8: Prefer HTTPS for the Apache 2.0 license URL.Minor but standardizes on TLS links.
Apply this diff:
-# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
.coderabbit.yaml(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: CI Pipeline / Check
🔇 Additional comments (2)
.coderabbit.yaml (2)
105-109: Label “! - Release” already exists—no update neededI’ve confirmed via the GitHub API that the repository already defines a label named
! - Release. Because it matches the code in.coderabbit.yaml, the auto‐apply action will succeed as written. You can safely ignore the original suggestion to rename it.Likely an incorrect or invalid review comment.
63-67: MyST support confirmed; Markdown guidance is valid
- Checked
pyproject.tomland found amyst-parser~=4.0dependency, and confirmedmyst_parseris enabled indocs/source/conf.py, so Markdown via MyST is fully supported.- The existing instruction “All documentation should be written in Markdown format” aligns with the repo’s Sphinx configuration.
Optional: for extra clarity, you could update the wording to explicitly reference MyST, e.g.:
- All documentation should be written in Markdown format. + All documentation should be written in Markdown format (using MyST).
…avid-coderabbit-config Signed-off-by: David Gardner <[email protected]>
willkill07
left a comment
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.
FYI, Dynamo's config is here: https://github.com/ai-dynamo/dynamo/blob/main/.coderabbit.yaml
Looks like we can also turn off poem
Signed-off-by: David Gardner <[email protected]>
That's what I started with, they left the poem on :) |
Signed-off-by: David Gardner <[email protected]>
willkill07
left a comment
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.
Approving with nits
Co-authored-by: Will Killian <[email protected]> Signed-off-by: David Gardner <[email protected]>
Signed-off-by: David Gardner <[email protected]>
…avid-coderabbit-config Signed-off-by: David Gardner <[email protected]>
|
/merge |
Description
.coderabbit.yamlBy Submitting this PR I confirm:
Summary by CodeRabbit