feat: coderabbit.ai config

[justinr1234]

No description provided.

[coderabbitai]

Walkthrough

The changes introduce a new configuration file, .coderabbit.yaml, which establishes settings for CodeRabbit's review and chat functionalities. It specifies language preferences, review profiles, and options for automatic reviews. The configuration allows for the generation of poems in comments, posting of review statuses, and automatic replies in chat without user tagging. This setup aims to streamline the review process and enhance user interaction with the bot.

Changes

Files	Change Summary
.coderabbit.yaml	Added configuration settings for review and chat functionalities, including language, reviews, and chat sections.

Poem

In the burrow deep, we cheer with glee,
A new config file, oh what a spree!
Reviews are chill, and chats flow free,
With poems and statuses, as fun as can be!
Hop along, dear friends, let’s celebrate,
CodeRabbit’s magic, oh isn’t it great! 🐰✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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

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.

[ckeshava]

I could use code-rabbit's reviews on draft PRs. It's helpful to get a round of comments before I open up the PRs.

Is that allowed under the open-source project plan? Can we enable it?

[justinr1234]

@mvadari any complaints?

[mvadari]

You can manually request reviews on drafts, I'd prefer to keep it automatically off so you don't get reviews before you're ready for them.

[ckeshava]

How do you manually request for PR reviews? "@CodeRabbit review" ?
If that's the case, I'm happy with the config 👍

[coderabbitai]

@ckeshava, yes, you can manually request a review by commenting @coderabbit review on your pull request. This will trigger CodeRabbit to perform a review when you're ready. If you're happy with the configuration, we can keep it as is. 👍