Skip to content

Update ast-grep docs with the new essential rules property #39

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 4 commits into from
Apr 6, 2024
Merged

Update ast-grep docs with the new essential rules property #39

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f702e72
Update ast-grep docs with the new essential rules property
petrisorcoderabbit Apr 6, 2024
ceb4534
Update docs/guides/review-instructions.md
petrisorcoderabbit Apr 6, 2024
01da60e
Fix typo
petrisorcoderabbit Apr 6, 2024
02b2f38
Merge remote-tracking branch 'origin/update_ast_grep_docs' into updat…
petrisorcoderabbit Apr 6, 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
Prev Previous commit
Next Next commit
Fix typo
  • Loading branch information
@petrisorcoderabbit
petrisorcoderabbit committed Apr 6, 2024
commit 01da60ef9fcffbc524adc805436be3688e086b08
14 changes: 7 additions & 7 deletions docs/guides/review-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,10 @@ your project.

```yaml
my-awesome-project # project root
|- rules # rule directory
| |- my-rule.yml
|- utils # utils directory
| |- is-literal.yml
|- rules # rule directory
| |- my-rule.yml
|- utils # utils directory
| |- is-literal.yml
```

> Also, you need to add the `rules` and `utils` directories to the
Expand Down Expand Up @@ -305,8 +305,8 @@ within your organization.

Packages provided by Coderabbit are:

- `ast-grep-essentials`: A set of essential security rules, because we value security, this package gets
it's own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite. Check
- `ast-grep-essentials`: A set of essential security rules. Because we value security, this package gets
its own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite. Check
the [package repository](https://github.com/coderabbitai/ast-grep-essentials)
for more information.

Expand Down Expand Up @@ -344,7 +344,7 @@ my-awesome-project # project root
| |- is-literal.yml
```

**rules** and **utils** directories are keywords and it should be the same. Inside each directory, the structure is up
**rules** and **utils** directories are keywords, and it should be the same. Inside each directory, the structure is up
to you. You can also have any other root directories or files beside the two shown above.

- package name should be in the format `organization/repository`
Expand Down