Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Add a new reference section for code guidelines. #483

Merged
merged 4 commits into from
Aug 5, 2025
Merged

Add a new reference section for code guidelines. #483

merged 4 commits into from
Aug 5, 2025
+110 −13

Conversation

jmacdotorg
Copy link
Contributor

@jmacdotorg jmacdotorg commented Jul 31, 2025 •
edited by coderabbitai bot
Loading

  • Adds a new section to the configuration page about code guidelines.
  • Rewrites the code guidelines section on the knowledge base base, explaining what the feature does and how it works by default, and directing the reader to the new configuration section for more detailed information.

Staged:

Summary by CodeRabbit

  • Documentation
    • Updated and clarified the description of how code guideline files are used in code reviews.
    • Revised instructions for specifying custom code guideline files and noted the feature is enabled by default.
    • Added detailed configuration options for managing code guideline files, including enabling/disabling the feature and specifying file patterns.
    • Provided both Web UI and YAML configuration examples for easier setup.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 31, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The documentation for CodeRabbit's knowledge base was refined to clarify how code guideline files define team coding standards and influence reviews. The configuration reference added a new "Code guidelines" section enabling users to toggle guideline enforcement and specify file patterns, with defaults for common AI assistant guideline files.

Changes

Cohort / File(s) Change Summary
Knowledge Base Documentation
docs/integrations/knowledge-base.md		 Revised the "Code Guidelines" section heading and description to clarify usage, removed explicit default file lists and images, and added references to configuration options.
Configuration Reference Update
docs/reference/configuration.md		 Added a new "Code guidelines" section under "Knowledge Base" settings detailing enable/disable toggle and customizable file pattern settings with default paths for guideline files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

In the docs, a fresh breeze blows,
Guideline wisdom now clearly shows.
Patterns and toggles, all in a row,
For teams to shape how their code should flow.
With every review, the standards grow—
CodeRabbit’s guidance, ready to go! 🐇✨

Pre-Merge Checks (2 passed, 1 warning)

❌ Failed Checks (1 warning)
Check Name Status Explanation Resolution
Title Check ⚠️ Warning The title only mentions adding a reference section but doesn’t reflect that the existing knowledge base code guidelines section has also been rewritten. Revise the title to include both parts, for example: "Update knowledge base code guidelines section and add configuration reference for code guidelines."
✅ Passed Checks (2 passed)
Check Name Status Explanation
Description Check ✅ Passed The description clearly summarizes the changes introduced and provides links to the staged documentation for review.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce65ce2 and 58acbd1.

📒 Files selected for processing (1)
  • docs/integrations/knowledge-base.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/integrations/knowledge-base.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch code-guidelines
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Aug 5, 2025 •
edited
Loading

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 58acbd1
Status: ✅  Deploy successful!
Preview URL: https://fbe28e07.coderabbit-docs.pages.dev
Branch Preview URL: https://code-guidelines.coderabbit-docs.pages.dev

View logs

smb06
smb06 suggested changes Aug 5, 2025
View reviewed changes
@jmacdotorg jmacdotorg merged commit ee5a787 into main Aug 5, 2025
4 checks passed
@jmacdotorg jmacdotorg deleted the code-guidelines branch August 5, 2025 19:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@edgarcerecerez edgarcerecerez Awaiting requested review from edgarcerecerez

2 more reviewers

@smb06 smb06 smb06 requested changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jmacdotorg @smb06