Skip to content

Add code guidelines description #408

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 2 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions docs/integrations/knowledge-base.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,21 @@ Or you can comment directly on some lines of code in the PR. `@coderabbitai do n
Watch our [video walkthrough on learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) for more information.

:::

## Code Guidelines {#code_guidelines}

CodeRabbit will analyse and learn from your organisation's code guidelines, which you can set up in the knowledge base section. These guidelines will then be used to conduct thorough code reviews.

The following patterns are scanned by default.

```text
**/.cursorrules
.github/copilot-instructions.md
**/CLAUDE.md
**/.cursor/rules/*
**/.windsurfrules
**/.clinerules/*
**/.rules/*
```

![Illustration of code guidelines configuration](/img/knowledge-base/code-guidelines.png)
Binary file added static/img/knowledge-base/code-guidelines.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.