Add a new reference section for code guidelines. #483

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.

Sign up for GitHub

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

Jump to bottom

Open

jmacdotorg wants to merge 1 commit into main from code-guidelines

Contributor

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.


          Add a new reference section for code guidelines. Rewrite the guide se…

998e421

…ction for code guidelines.

jmacdotorg requested review from edgarcerecerez and smb06

July 31, 2025 19:37

Contributor

coderabbitai bot commented Jul 31, 2025 •

edited

Loading

Caution

Review failed

Failed to post review comments.

📝 Walkthrough

Walkthrough

The documentation for CodeRabbit's knowledge base and configuration was updated. The knowledge base guide now provides a clearer explanation of how code guideline files are used, while the configuration reference introduces a new section detailing how to enable and customize code guideline file patterns for code reviews.

Changes

Cohort / File(s)	Change Summary
Knowledge Base Documentation `docs/integrations/knowledge-base.md`	Revised the "Code Guidelines" section for clarity, updated heading anchors, removed default file patterns and images, and added configuration references.
Configuration Reference Update `docs/reference/configuration.md`	Added a new "Code guidelines" section under "Knowledge Base" settings, detailing feature enablement, file pattern configuration, and default paths.

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 (1 passed, 2 warnings)

❌ Failed Checks (2 warnings)

Check Name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title only mentions adding a reference section for code guidelines and omits the significant rewrite of the knowledge-base code guidelines section.	Revise the title to cover both the new configuration reference section and the knowledge-base section update—for example: Add code guidelines reference section to configuration docs and update knowledge-base documentation.
Description Check	⚠️ Warning	The description lists high-level changes but lacks context, motivation, detailed file impacts, and there's no PR template guiding its structure.	Add a pull request template to the repository and expand the description with the motivation for the changes, specific file updates, and testing or review instructions.

✅ Passed Checks (1 passed)

Check Name	Status	Explanation
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.

✨ 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.
- @coderabbitai modularize this function.
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.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet