Commit7122194

authored

Add code guidelines description (#408)

* Add code guidelines description* Resolve nitpicks

1 parentb8ca77e commit7122194Copy full SHA for 7122194

File tree

+18

-0

lines changed

+18

-0

lines changed

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -22,3 +22,21 @@ Or you can comment directly on some lines of code in the PR. `@coderabbitai do n
`22`	`22`	`Watch our[video walkthrough on learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) for more information.`
`23`	`23`
`24`	`24`	`:::`
	`25`	`+`
	`26`	`+##Code Guidelines {#code_guidelines}`
	`27`	`+`
	`28`	`+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.`
	`29`	`+`
	`30`	`+The following patterns are scanned by default.`
	`31`	`+`
	`32`	+```text
	`33`	`+**/.cursorrules`
	`34`	`+.github/copilot-instructions.md`
	`35`	`+**/CLAUDE.md`
	`36`	`+*/.cursor/rules/`
	`37`	`+**/.windsurfrules`
	`38`	`+*/.clinerules/`
	`39`	`+*/.rules/`
	`40`	+```
	`41`	`+`
	`42`	`+![Illustration of code guidelines configuration](/img/knowledge-base/code-guidelines.png)`

67.5 KB

Comments

(0)