Skip to content

adding default blocked paths #403

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 18, 2025
Merged

Conversation

alexcoderabbitai
Copy link
Collaborator

No description provided.

Copy link
Contributor

coderabbitai bot commented Jun 18, 2025

Caution

Review failed

Failed to post review comments.

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

📥 Commits

Reviewing files that changed from the base of the PR and between ba46f31 and aeab166.

⛔ Files ignored due to path filters (1)
  • static/img/guides/path-filters.png is excluded by !**/*.png, !**/*.png
📒 Files selected for processing (1)
  • docs/guides/review-instructions.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/review-instructions.md

[style] ~128-~128: This phrase is redundant (‘G’ stands for ‘graphic’). Use simply “SVG”.
Context: ...n file | | !**/*.svg | SVG image | | !**/*.jpeg | JPEG i...

(ACRONYM_TAUTOLOGY)


[style] ~131-~131: This phrase is redundant (‘G’ stands for ‘graphic’). Use simply “PNG”.
Context: ...G image | | !**/*.png | PNG image | | !**/*.gif | GIF im...

(ACRONYM_TAUTOLOGY)


[style] ~167-~167: This phrase is redundant (‘OS’ stands for ‘operating system’). Use simply “macOS”.
Context: ...le | | !**/.DS_Store | macOS system file | | !**/.cscope.files | Cscop...

(ACRONYM_TAUTOLOGY)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
docs/guides/review-instructions.md (1)

22-28: Approve new Default Blocked Paths section

The addition clearly explains default exclusions and how to override them, improving user transparency.

Walkthrough

A new section titled "Default Blocked Paths" was added to the documentation file docs/guides/review-instructions.md. This section details which file paths and extensions are excluded from review by default and provides instructions for overriding these exclusions through configuration. No changes were made to code or existing instructions.

Changes

File(s) Change Summary
docs/guides/review-instructions.md Added a detailed section listing default blocked paths, file types, and instructions for override. Includes categorized glob patterns and a screenshot illustration.

Poem

🐇
In docs, a list now shines so bright,
Of paths and files kept out of sight.
If you wish to review what’s blocked by default,
Just tweak the filters—no need to halt!
The rabbit hops with knowledge new,
To guide your code reviews straight and true.
📄✨

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch feat/default-excluded-paths

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

Copy link

cloudflare-workers-and-pages bot commented Jun 18, 2025

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: aeab166
Status: ✅  Deploy successful!
Preview URL: https://b8634041.coderabbit-docs.pages.dev
Branch Preview URL: https://feat-default-excluded-paths.coderabbit-docs.pages.dev

View logs

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 (3)
docs/guides/review-instructions.md (3)

26-235: Consider breaking out the long table into an include
This <details> block is comprehensive but very large. For maintainability, you could move the default patterns into a separate Markdown include or JSON/YAML snippet and pull it in. This keeps the main guide focused and makes updates easier.


128-131: Remove redundant “image” label in descriptions
“Acronym tautology” applies here. The file extensions imply the format already. Consider changing:

- | `!**/*.svg`   | SVG image              |
+ | `!**/*.svg`   | SVG file               |

- | `!**/*.png`   | PNG image              |
+ | `!**/*.png`   | PNG file               |

237-237: Add descriptive alt text to the screenshot
For accessibility, replace the generic filename alt text with a concise description. For example:

-![Screenshot 2025-06-18 at 2 46 57 PM](https://github.com/user-attachments/assets/8592f452-9ecd-44f2-8fcf-cd87c56aa093)
+![Default Blocked Paths configuration in Path Filters UI](https://github.com/user-attachments/assets/8592f452-9ecd-44f2-8fcf-cd87c56aa093)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a4be160 and ba46f31.

📒 Files selected for processing (1)
  • docs/guides/review-instructions.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/review-instructions.md

[style] ~128-~128: This phrase is redundant (‘G’ stands for ‘graphic’). Use simply “SVG”.
Context: ...n file | | !**/*.svg | SVG image | | !**/*.jpeg | JPEG i...

(ACRONYM_TAUTOLOGY)


[style] ~131-~131: This phrase is redundant (‘G’ stands for ‘graphic’). Use simply “PNG”.
Context: ...G image | | !**/*.png | PNG image | | !**/*.gif | GIF im...

(ACRONYM_TAUTOLOGY)


[style] ~167-~167: This phrase is redundant (‘OS’ stands for ‘operating system’). Use simply “macOS”.
Context: ...le | | !**/.DS_Store | macOS system file | | !**/.cscope.files | Cscop...

(ACRONYM_TAUTOLOGY)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: fix
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
docs/guides/review-instructions.md (1)

22-25: New section is clear and well-placed
The “Default Blocked Paths” heading and intro succinctly explain the feature and how to override it.

@alexcoderabbitai alexcoderabbitai marked this pull request as ready for review June 18, 2025 18:57
@alexcoderabbitai alexcoderabbitai merged commit 228e9f5 into main Jun 18, 2025
4 checks passed
@alexcoderabbitai alexcoderabbitai deleted the feat/default-excluded-paths branch June 18, 2025 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant