Skip to content

Commit d52ca17

Browse files
adding guide on issue creation (#250)
1 parent e1cf3e7 commit d52ca17

File tree

5 files changed

+58
-2
lines changed

5 files changed

+58
-2
lines changed

docs/guides/agent_chat.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Set `enabled` to false within `web_search` within `knowledge_base` within the co
3737

3838
### Jira and Linear Integration
3939

40-
CodeRabbit Chat can deal with existing issue tracking system integrations in order to integrate with your existing issues. For details on setting up issue tracking integrations, see our [Issue Integrations](../integrations/issue-integrations.md) guide.
40+
CodeRabbit Chat can deal with existing issue tracking system integrations in order to integrate with your existing issues. For details on setting up issue tracking integrations, see our [Issue Integrations](../integrations/issue-integrations.md) guide and [Issue Creation](./issue-creation.md) guide.
4141

4242
### Learnings Integration
4343

docs/guides/issue-creation.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Issue Creation
3+
sidebar_label: Issue Creation
4+
description: Learn how to create issues directly through CodeRabbit
5+
sidebar_position: 9
6+
---
7+
8+
```mdx-code-block
9+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
10+
11+
<ProPlanNotice />
12+
```
13+
14+
CodeRabbit provides seamless issue creation capabilities across multiple platforms including GitHub, GitLab, Jira, and Linear. You can create issues directly from pull request discussions or through the agentic chat interface.
15+
16+
## Creating Issues Through Agentic Chat
17+
18+
Using CodeRabbit's chat functions, you can create issues naturally through conversations in comments or comment threads. Simply mention `@coderabbitai` and ask to create an issue.
19+
20+
![Creating issues inline](/img/guides/create-issue-inline.png)
21+
22+
When using CodeRabbit's [agentic chat](./agent_chat.md), CodeRabbit will help you format and create the issue with appropriate details based on your description and desired issue platform.
23+
24+
![Creating issues through agentic chat](/img/guides/create-issue-agentic.png)
25+
26+
## Supported Platforms
27+
28+
### GitHub Issues
29+
30+
CodeRabbit can create GitHub issues directly in your repository. The integration works automatically without additional setup.
31+
32+
### GitLab Issues
33+
34+
Similar to GitHub, GitLab issue creation is supported out of the box.
35+
36+
### Jira
37+
38+
To create Jira issues, ensure you have [configured the Jira integration](../integrations/issue-integrations.md#jira) first.
39+
40+
### Linear
41+
42+
Make sure you have [set up the Linear integration](../integrations/issue-integrations.md#linear) to create Linear issues.
43+
44+
## Tips for Issue Creation
45+
46+
- Use natural language when creating issues through agentic chat
47+
- Include code snippets when relevant
48+
- Specify assignees if known
49+
- Set appropriate priorities
50+
- Add deadlines or milestones if applicable
51+
52+
For more detailed information about issue tracking integrations, see our [Issue Integrations](../integrations/issue-integrations.md) guide.

docs/integrations/issue-integrations.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,15 @@ To link a Jira Issue, you can add the Jira Issue into the PR description as show
3737
Closes CR-5
3838
```
3939

40+
You can also create new Jira issues directly through CodeRabbit. See our [Issue Creation guide](../guides/issue-creation.md#jira) for details.
41+
4042
## Linear {#Linear}
4143

4244
```mdx-code-block
4345
<ProPlanNotice />
4446
```
4547

46-
With CodeRabbit, you can easily link your pull requests with Linear. It makes your life simpler by automatically creating Linear issues with all the code context, keeping your issues and pull requests in sync both ways. Plus, it lets you generate issues straight from pull requests, track how youre hitting your goals, and even turn code review feedback into actionable tasks in Linear.
48+
With CodeRabbit, you can easily link your pull requests with Linear. It makes your life simpler by automatically creating Linear issues with all the code context, keeping your issues and pull requests in sync both ways. Plus, it lets you generate issues straight from pull requests, track how you're hitting your goals, and even turn code review feedback into actionable tasks in Linear.
4749

4850
### CodeRabbit App
4951

@@ -67,6 +69,8 @@ To link a Linear Issue, you can add the Linear Issue via the team key and issue
6769
Closes ENG-123
6870
```
6971

72+
You can also create new Linear issues directly through CodeRabbit. Learn more in our [Issue Creation guide](../guides/issue-creation.md#linear).
73+
7074
## GitHub
7175

7276
```mdx-code-block
162 KB
Loading
97.1 KB
Loading

0 commit comments

Comments
 (0)