Skip to content

Add a note explaining why CodeRabbit requests read-write access. #320

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a note explaining why CodeRabbit requests read-write access. #320

wants to merge 2 commits into from
+3 −0

Conversation

jmacdotorg
Copy link
Collaborator

@jmacdotorg jmacdotorg commented May 1, 2025 •
edited
Loading

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 1, 2025 •
edited
Loading

Walkthrough

A note was added to the Quickstart documentation, immediately after the instruction to click "Install & Authorize" when adding CodeRabbit to a GitHub repository. The note explains why CodeRabbit requests read and write access, outlines the features enabled by these permissions, assures users that their code is never stored, and provides a link to the CodeRabbit Trust Center for further information. No other documentation or code changes were introduced.

Changes

File(s) Change Summary
docs/getting-started/quickstart.md Added a clarifying note about permission requirements, data handling, and a Trust Center link.

Assessment against linked issues

Objective Addressed Explanation
Clarify the reasons for giving GitHub permission, in the Quickstart (#307) ✅

Poem

A hop to the docs, a skip to the note,
Now permissions are clear, in bold we wrote.
No code is stored, your trust is key,
Check the Trust Center for transparency!
With every new change, we’re upfront and bright—
CodeRabbit’s here to make things right.
🐰✨

✨ Finishing Touches
  • 📝 Generate Unit Tests in Pull Request
🪧 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.

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 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.
coderabbitai[bot]
coderabbitai bot reviewed May 1, 2025
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

🧹 Nitpick comments (1)
docs/getting-started/quickstart.md (1)

47-49: Ensure proper nesting and formatting for the admonition.
The note is indented by 3 spaces under the list item, but Markdown requires at least 4 spaces to nest block elements (including :::note) within a list. Also, add blank lines before and after the admonition for clear separation. Apply this diff:

@@ -46,6 +46,8 @@ 1. Click **Install & Authorize**.
-   :::note
-   CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai).
-   :::
+    
+    :::note
+    CodeRabbit requests read and write access to your repository to enable its code review, issue management, and pull request generation features.
+
+    CodeRabbit never stores your code. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai).
+    :::
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fe08df3 and 2140540.

📒 Files selected for processing (1)
  • docs/getting-started/quickstart.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Cloudflare Pages
@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2140540
Status: ✅  Deploy successful!
Preview URL: https://4f563ae2.coderabbit-docs.pages.dev
Branch Preview URL: https://quickstart-trust.coderabbit-docs.pages.dev

View logs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant
@jmacdotorg