10000 docs: removed duplicate content from review-instructions.md by tyaga001 · Pull Request #113 · coderabbitai/coderabbit-docs · GitHub
[go: up one dir, main page]
Skip to content

docs: removed duplicate content from review-instructions.md #113

8000
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

Merged
merged 1 commit into from
Oct 21, 2024
Merged

docs: removed duplicate content from review-instructions.md #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 3 additions & 17 deletions docs/guides/review-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ This section explains how to add custom code review instructions for the entire
project or specific file paths in your project using glob patterns. Developers
can provide tailored review guidelines based on the file paths. These
instructions are needed only if you want CodeRabbit to follow specific
instructions besides the standard review. For example, you may want to enforce a
style guide by file types or directories.
instructions besides the standard review.

>For example, you may want to enforce a style guide by file types or directories.
### Sample Usage

Expand Down Expand Up @@ -72,21 +73,6 @@ learning curve involved.

:::

CodeRabbit offers review instructions based on Abstract Syntax Tree (AST)
patterns. Under the hood, CodeRabbit uses
[`ast-grep`](https://ast-grep.github.io) to power this feature. `ast-grep` is
written in Rust and uses the tree-sitter parser to generate the AST for popular
languages. `ast-grep` is written and maintained by
[Herrington Darkholme](https://twitter.com/hd_nvim).

:::tip

`ast-grep` Playground is quite effective in designing and testing AST rules on
source code snippets. You can access the playground
[here](https://ast-grep.github.io/playground.html).

:::

:::note

**Deep dive into AST patterns and `ast-grep` rules**
Expand Down
0