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

updateschemaexample #31

Merged
merged 2 commits into from
Mar 25, 2024
Merged

updateschemaexample #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f0ba25
updateschemaexample
guritfaq Mar 25, 2024
7a967b8
Update customize-coderabbit.md
guritfaq Mar 25, 2024
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
27 changes: 12 additions & 15 deletions docs/guides/customize-coderabbit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,13 @@ reviews:
- "feat/.*"
tools:
ast-grep:
rules_directory: "custom-rules-directory-name"
utils_directory: "custom-utils-directory-name"
rule_dirs:
- "rules"
util_dirs:
- "utils"
packages:
- "ast-grep-essentials"
- "my-awesome-org/my-awesome-package" # public repository that contains ast-grep
chat:
auto_reply: true
```
Comment on lines 55 to 67
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [9-9]

Consider removing the extra spaces between "below" and "options" for consistency in the document's formatting.

- using one of the below   options.
+ using one of the below options.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [71-71]

The note about the .coderabbit.yaml file placement should start with an uppercase letter for consistency with the rest of the document.

- `.coderabbit.yaml` file should be placed in the root directory of the repository.
+ `.coderabbit.yaml` file should be placed in the root directory of the repository.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [129-129]

The header for version 1 should start with an uppercase letter to maintain consistency with the document's formatting.

- #### version 1: `deprecated` (Please use version [version 2](/guides/customize-coderabbit))
+ #### Version 1: `deprecated` (Please use version [version 2](/guides/customize-coderabbit))

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [217-217]

There seems to be an unpaired symbol in the markdown link. Ensure that the markdown syntax for the link is correct.

- section [Prompt Customization](/guides/prompt-customization)
+ section [Prompt Customization](/guides/prompt-customization)

Expand Down Expand Up @@ -105,10 +110,11 @@ YAML settings:
apart from the default branch. Accepts regex pattern.
- **`tools`**: Configurations for the tools used in the review.
- **`ast-grep`**: Configurations for the `ast-grep` tool.
- **`rules_directory`**: The directory name where the custom `ast-grep`
- **`rule_dirs`**: The directory name where the custom `ast-grep`
rules are stored.
- **`utils_directory`**: The directory name where the custom `ast-grep`
- **`util_dirs`**: The directory name where the custom `ast-grep`
utils are stored.
- **`packages`**: A package allows you to share rules across multiple projects. Essentially, a package is a collection of `ast-grep` rules.
4. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
- **`auto_reply`**: The bot automatically replies without the need of the
user tagging it (default: `true`).
Expand Down Expand Up @@ -155,11 +161,7 @@ settings:
# Disable automatic code reviews for this repository.
disable_review: false
# External tools configurations
tools:
# tools configuration for ast-grep
ast-grep:
rules_directory: "custom-rules-directory-name"
utils_directory: "custom-utils-directory-name"

```

This configuration file consists of the following settings:
Expand Down Expand Up @@ -191,12 +193,7 @@ This configuration file consists of the following settings:
be posted.
13. **`collapse_walkthrough_comment`**: Specifies whether to collapse
walkthrough comments on the review.
14. **`tools`**: Configurations for the tools used in the review.
- **`ast-grep`**: Configurations for the `ast-grep` tool.
- **`rules_directory`**: The directory name where the custom `ast-grep`
rules are stored.
- **`utils_directory`**: The directory name where the custom `ast-grep`
utils are stored.


Refer:
[CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json).
Expand Down