asyncapi / asyncapi/website

[FEATURE] CodeRabbitAI Knowledge-Base–Aware

Open
#5,291 3 comments 0 reactions 0 assignees View on GitHub
enhancement triaged
Dominant language
TypeScript
Stars
716
Forks
1.2k
Avg merge
1d 12h
Merged PRs (30d)
35

Description

### Why do we need this improvement?

Making the CodeRabbitAI review more effectively by providing context of the repository. Inspired from https://github.com/asyncapi/generator/issues/1816 and suggested by Lukasz [here](https://asyncapi.slack.com/archives/C02FK3YDPCL/p1774010023533279?thread_ts=1773914311.579079&cid=C02FK3YDPCL)

### How will this change help?

It will help the maintainers _(and anyone reviewing the PRs)_ be more efficient and easy to review _(and hopefully resolve the issue!)_

### Screenshots

_No response_

### How could it be implemented/designed?

1. A change in the coderabbit YAML file
2. A custom PR review checklist for coderabbit similar to https://github.com/asyncapi/generator/blob/master/.github/pr-review-checklist.md

### 🚧 Breaking changes

No

### 👀 Have you checked for similar open issues?

- [x] I checked and didn't find a similar issue

### 🏢 Have you read the Contributing Guidelines?

- [x] I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)

### Are you willing to work on this issue?

Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Inspect the repository's CodeRabbit YAML configuration and compare the proposed checklist with the referenced .github/pr-review-checklist.md example. Confirm how repository context and review guidance are currently configured, then consider the issue complete when the configuration and checklist provide the intended repository-aware review context.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.