Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Removed a typo, and rewrote a paragraph for clarity.#424

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

jmacdotorg
Copy link
Contributor

@jmacdotorgjmacdotorg commentedJul 1, 2025•
edited
Loading

@jmacdotorgjmacdotorg linked an issueJul 1, 2025 that may beclosed by this pull request
@coderabbitaicoderabbitai
Copy link
Contributor

coderabbitaibot commentedJul 1, 2025•
edited
Loading

Walkthrough

The documentation for initial configuration was updated to clarify how users can adjust path-specific CodeRabbit behavior. The revised section now explicitly explains that users may provide custom instructions for certain files or directories or configure CodeRabbit to ignore specific paths during code reviews.

Changes

File(s)Change Summary
docs/guides/initial-configuration.mdClarified and expanded the explanation for path-specific behavior configuration in documentation

Poem

In the warren of docs, a new note appears,
Clearer instructions to calm any fears.
Now paths can be told to hush or to speak,
With guidance for every file you seek.
Hippity-hop, the docs shine anew—
CodeRabbit’s reviews are clearer for you!

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in a Comment
  • Commit Unit Tests in branch423-typo-and-and-on-the-new-configuration-guide
🪧 Tips

Chat

There are 3 ways to chat withCodeRabbit:

  • 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 oursupport 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 togenerate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-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 theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
  • Join ourDiscord Community to get help, request features, and share feedback.
  • Follow us onX/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitaicoderabbitaibot 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/guides/initial-configuration.md (1)

80-82:Prefer “ignore” over “disregard” for consistency with the surrounding docs
Elsewhere in the guide (see lines 88–90) we use “disregard” only when describing theoutcome of a filter; in headings and intro sentences we say “ignore”. Swapping “disregard” for “ignore” here keeps terminology consistent and reads a bit more naturally.

-You can give CodeRabbit additional instructions for reviewing specific files or-locations in your repository, or configure CodeRabbit to disregard certain file paths-during code reviews.+You can give CodeRabbit additional instructions for reviewing specific files or+locations in your repository, or configure CodeRabbit to ignore certain file paths+during code reviews.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between5b85004 andb828c44.

📒 Files selected for processing (1)
  • docs/guides/initial-configuration.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: alexcoderabbitaiPR: coderabbitai/coderabbit-docs#0File: :0-0Timestamp: 2025-06-02T14:07:49.512ZLearning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: aravindputrevuPR: coderabbitai/coderabbit-docs#121File: docs/guides/delete-account.md:46-47Timestamp: 2024-10-31T16:33:25.070ZLearning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
Learnt from: alexcoderabbitaiPR: coderabbitai/coderabbit-docs#176File: docs/self-hosted/bitbucket.md:37-37Timestamp: 2024-12-13T15:10:43.483ZLearning: In the `docs` repository, it's acceptable to use `127.0.0.1` in documentation examples, and CodeRabbit should not flag it as an issue.
Learnt from: NatoBoramPR: coderabbitai/coderabbit-docs#125File: CONTRIBUTING.md:60-65Timestamp: 2024-10-31T17:01:26.168ZLearning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.
Learnt from: tyaga001PR: coderabbitai/coderabbit-docs#155File: docs/getting-started/quickstart.md:22-22Timestamp: 2024-11-28T16:45:08.224ZLearning: In the `coderabbitai/coderabbit-docs` repository, when reviewing markdown files, image paths that start with `/img/` are correct and should not include the `static` prefix, even though the images are located in the `static/` directory.
Learnt from: aravindputrevuPR: coderabbitai/coderabbit-docs#402File: docs/guides/setup-best-practices.md:21-21Timestamp: 2025-06-18T09:22:07.198ZLearning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
docs/guides/initial-configuration.md (4)
Learnt from: alexcoderabbitaiPR: coderabbitai/coderabbit-docs#0File: :0-0Timestamp: 2025-06-02T14:07:49.512ZLearning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: aravindputrevuPR: coderabbitai/coderabbit-docs#402File: docs/guides/setup-best-practices.md:21-21Timestamp: 2025-06-18T09:22:07.198ZLearning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
Learnt from: aravindputrevuPR: coderabbitai/coderabbit-docs#121File: docs/guides/delete-account.md:46-47Timestamp: 2024-10-31T16:33:25.070ZLearning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
Learnt from: NatoBoramPR: coderabbitai/coderabbit-docs#125File: CONTRIBUTING.md:60-65Timestamp: 2024-10-31T17:01:26.168ZLearning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages

@cloudflare-workers-and-pagesCloudflare Workers and Pages
Copy link

cloudflare-workers-and-pagesbot commentedJul 1, 2025•
edited
Loading

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit:eaae20c
Status: ✅  Deploy successful!
Preview URL:https://d19ae79f.coderabbit-docs.pages.dev
Branch Preview URL:https://423-typo-and-and-on-the-new.coderabbit-docs.pages.dev

View logs

@jmacdotorgjmacdotorgenabled auto-merge (squash)July 2, 2025 15:50
@jmacdotorgjmacdotorg merged commitb296a2f intomainJul 2, 2025
4 checks passed
@jmacdotorgjmacdotorg deleted the 423-typo-and-and-on-the-new-configuration-guide branchJuly 2, 2025 15:50
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@howonleehowonleehowonlee approved these changes

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

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Typo "and and" on the new configuration guide
2 participants
@jmacdotorg@howonlee
[8]ページ先頭
©2009-2025 Movatter.jp