Skip to content

Commit

Permalink
docs(code-review): add CodeRabbit section
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyFriesenGitHub authored and MFarabi619 committed Dec 22, 2024
1 parent e848655 commit b4d45ac
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions apps/docs/content/docs/contribution-guidelines/code-review.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,29 @@ description: 📳🧐‍💻 🤔💭⁉️. WIP.
icon: Laptop
---

import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

<Callout>
If you want to break into FAANG, make sure to rebase onto `main` before
continuing work.
</Callout>

## CodeRabbit Automated Reviews
<Accordions>
<Accordion title="What is CodeRabbit?">
CodeRabbit is an AI-powered code review tool that summarizes and automatically provides feedback on a pull request.
</Accordion>

<Accordion title="Why does cuHacking use CodeRabbit?">
cuHacking uses CodeRabbit because it helps:
- **Summarize** the changes made in a pull request
- **Suggest** improvements to the code
- **Reduce** overhead for reviewers
</Accordion>

<Accordion title="Should I ignore CodeRabbit's feedback?">
Generally speaking, developers should try to integrate suggested CodeRabbit feedback into their pull requests. Its not necessary to make all the changes, but it is recommended to consider them.
</Accordion>
</Accordions>

Check out [CodeRabbit's docs site](https://docs.coderabbit.ai/).

0 comments on commit b4d45ac

Please sign in to comment.