Skip to content
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

chore: add coderabbitai config rule to ignore generated documentation #502

Merged
merged 1 commit into from
May 22, 2024
Merged

chore: add coderabbitai config rule to ignore generated documentation #502

merged 1 commit into from
May 22, 2024

Conversation

bdeneux
Copy link
Contributor

@bdeneux bdeneux commented May 22, 2024 •
edited by coderabbitai bot
Loading

Implement #500. Nothing more to say ;)

Summary by CodeRabbit

  • New Features
    • Introduced configuration for filtering paths related to reviews.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 22, 2024 •
edited
Loading

Warning

Rate Limit Exceeded

@bdeneux has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 31 minutes and 20 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between b9a15eb and 5f5f7f2.

Walkthrough

The project now includes a .coderabbit.yaml configuration file, which introduces filtering for paths related to reviews. This enhancement aims to streamline the review process by specifying which paths should be included or excluded.

Changes

File Change Summary
.coderabbit.yaml Added configuration for filtering paths related to reviews in the project

In the code, a new path we weave,
For reviews to easily perceive.
With .coderabbit.yaml in tow,
Our filters guide where changes flow.
🐇✨
— A Rabbit's Ode to Configuration

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@bdeneux bdeneux linked an issue May 22, 2024 that may be closed by this pull request
👷 Add CoderabbitAI configuration to ignore generated docs #500
Closed
@bdeneux bdeneux force-pushed the chore/ignore-coderabbitai branch from b9a15eb to 5f5f7f2 Compare May 22, 2024 12:41
coderabbitai[bot]
coderabbitai bot reviewed May 22, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1b2c68a and b9a15eb.
Files selected for processing (1)
  • .coderabbit.yaml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .coderabbit.yaml

bot-anik
bot-anik reviewed May 22, 2024
View reviewed changes
Copy link
Member

@bot-anik bot-anik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Device URL
desktop http://localhost:3000/

Device URL
mobile http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

@bdeneux bdeneux requested review from ccamel and amimart May 22, 2024 12:52
@bdeneux bdeneux self-assigned this May 22, 2024
ccamel
ccamel approved these changes May 22, 2024
View reviewed changes
Copy link
Member

@ccamel ccamel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect 👌

@bdeneux bdeneux merged commit 7c6b352 into main May 22, 2024
12 checks passed
@bdeneux bdeneux deleted the chore/ignore-coderabbitai branch May 22, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@bot-anik bot-anik bot-anik left review comments

@amimart amimart amimart approved these changes

@ccamel ccamel ccamel approved these changes

Assignees

@bdeneux bdeneux

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

👷 Add CoderabbitAI configuration to ignore generated docs
4 participants
@bdeneux @ccamel @amimart @bot-anik