-
Notifications
You must be signed in to change notification settings - Fork 39
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
--- | ||
title: Issue Chat | ||
sidebar_label: Issue Chat | ||
description: Learn how to use CodeRabbit's chat capabilities within issues | ||
sidebar_position: 10 | ||
--- | ||
|
||
```mdx-code-block | ||
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; | ||
|
||
<ProPlanNotice /> | ||
``` | ||
|
||
# Issue Chat | ||
|
||
CodeRabbit provides an intelligent chat interface directly within GitHub and GitLab issues. This allows developers to have natural conversations about code, get answers to questions, create AI powered code searches, plan features, and gain deeper insights into their codebase - all without leaving their issue tracking workflow. | ||
|
||
## Getting Started | ||
|
||
To start a conversation with CodeRabbit in any issue: | ||
|
||
1. Simply mention `@coderabbitai` (or your custom bot name if configured) in an issue comment | ||
2. Ask your question or make your request in natural language | ||
3. CodeRabbit will analyze the context and respond accordingly | ||
|
||
:::note | ||
Organizations can configure a custom bot name by creating their own bot user. The bot will respond to mentions of that custom name instead of `@coderabbitai`. | ||
::: | ||
|
||
 | ||
|
||
 | ||
|
||
## Core Capabilities | ||
|
||
### Code Analysis | ||
|
||
When chatting in issues, CodeRabbit has access to your repository and powerful tools that allow it to analyze and understand your codebase like a real developer. This includes: | ||
|
||
- Full access to search and analyze the repository code | ||
- Advanced static analysis capabilities | ||
- Command line tools for code search and manipulation (e.g. grep, awk, sed, etc.) | ||
- Complete git history and metadata information | ||
- Access to past CodeRabbit learnings and insights | ||
|
||
This allows CodeRabbit to: | ||
|
||
- Search through code to find relevant examples | ||
- Analyze code patterns and relationships | ||
- Generate statistics and metrics | ||
- Provide context-aware answers about the codebase | ||
- Create AI powered code searches | ||
- Use tribal knowledge from learnings to enhance responses | ||
|
||
 | ||
|
||
 | ||
|
||
### Agentic Thought Chain | ||
|
||
When [agentic thought chain](./agent_chat.md) is enabled, CodeRabbit will use an agentic thought chain to plan out a response using multiple commands in series to articulate a more advanced response. | ||
|
||
 | ||
|
||
### Feature Planning Support | ||
|
||
Issue chat is particularly valuable during feature planning phases: | ||
|
||
- **Code Impact Analysis**: Ask about which parts of the codebase might be affected by proposed changes | ||
- **Pattern Discovery**: Find similar implementations or related code | ||
- **Dependency Mapping**: Understand relationships between components | ||
- **Technical Feasibility**: Get insights into potential challenges or approaches | ||
|
||
Example conversation: | ||
|
||
 | ||
|
||
## Additional Use Cases | ||
|
||
### Open Source Support | ||
|
||
Issue chat, like all Pro CodeRabbit features, is free for open source projects. CodeRabbit acts as a powerful support tool for open source maintainers by: | ||
|
||
- Answering common user questions with detailed, contextual responses | ||
- Providing relevant code examples and implementation patterns | ||
- Explaining error messages with debugging context and solutions | ||
- Suggesting step-by-step debugging approaches with code snippets | ||
- Helping triage and categorize issues | ||
- Identifying potential duplicates and related issues | ||
- Offering guidance on best practices and common pitfalls | ||
- Reducing maintainer burden by handling routine support tasks | ||
|
||
Example: | ||
|
||
 | ||
|
||
### Documentation Assistance | ||
|
||
Use issue chat to generate high level descriptions of the code and services in your repositories. This can be used to create README documentation which can be used across platforms like [wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis), [Confluence](https://www.atlassian.com/software/confluence/guides), [Notion](https://www.notion.so/help/guides) and more: | ||
|
||
- Generate high level documentation | ||
- Create usage examples and mermaid diagrams | ||
- Provide content to assist in updating README files | ||
- Write tutorials | ||
|
||
Example: | ||
|
||
 | ||
|
||
### Marketing Content Generation | ||
|
||
CodeRabbit can assist with creating content on new features for social media posts, blogs, and more: | ||
|
||
- Release announcements | ||
- Blog post drafts | ||
- Social media content | ||
- Community updates | ||
|
||
Example: | ||
|
||
 | ||
|
||
## Best Practices | ||
|
||
1. **Be Specific** | ||
|
||
- Provide context in your questions | ||
- Mention specific files or features when relevant | ||
- Clarify your goals or requirements | ||
|
||
2. **Iterative Refinement** | ||
|
||
- Start with broad questions | ||
- Follow up for more details | ||
- Ask for clarification when needed | ||
|
||
3. **Collaborative Planning** | ||
|
||
- Include stakeholders in the conversation | ||
- Use issue chat to document decisions | ||
- Reference related issues or PRs | ||
|
||
4. **Keep Questions Focused** | ||
- CodeRabbit works best with clear, specific questions | ||
- Link to specific files, directories or pull requests to help refine answers and provide better context | ||
- CodeRabbit does not generate API documentation, Swagger specs, or other technical documentation that requires high accuracy | ||
- Break down complex questions into smaller, more manageable ones | ||
- Use multiple messages to ask follow up questions if needed | ||
|
||
## Related Resources | ||
|
||
- [Agentic Chat](./agent_chat.md) | ||
- [Issue Creation](./issue-creation.md) | ||
- [Commands](./commands.md) | ||
- [Tooling Guide](../tools/tools.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
issue chat docs #254
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
Uh oh!
There was an error while loading. Please reload this page.
issue chat docs #254
Changes from all commits
4832e22
48dfa1e
c35570a
4f59517
f7a09e6
47f982d
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.