diff --git a/docs/guides/agent_chat.md b/docs/guides/agent_chat.md index d60679ae..afc5484f 100644 --- a/docs/guides/agent_chat.md +++ b/docs/guides/agent_chat.md @@ -37,7 +37,7 @@ Set `enabled` to false within `web_search` within `knowledge_base` within the co ### Jira and Linear Integration -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. +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. ### Learnings Integration diff --git a/docs/guides/issue-creation.md b/docs/guides/issue-creation.md new file mode 100644 index 00000000..f3e81f1d --- /dev/null +++ b/docs/guides/issue-creation.md @@ -0,0 +1,52 @@ +--- +title: Issue Creation +sidebar_label: Issue Creation +description: Learn how to create issues directly through CodeRabbit +sidebar_position: 9 +--- + +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + +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. + +## Creating Issues Through Agentic Chat + +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. + +![Creating issues inline](/img/guides/create-issue-inline.png) + +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. + +![Creating issues through agentic chat](/img/guides/create-issue-agentic.png) + +## Supported Platforms + +### GitHub Issues + +CodeRabbit can create GitHub issues directly in your repository. The integration works automatically without additional setup. + +### GitLab Issues + +Similar to GitHub, GitLab issue creation is supported out of the box. + +### Jira + +To create Jira issues, ensure you have [configured the Jira integration](../integrations/issue-integrations.md#jira) first. + +### Linear + +Make sure you have [set up the Linear integration](../integrations/issue-integrations.md#linear) to create Linear issues. + +## Tips for Issue Creation + +- Use natural language when creating issues through agentic chat +- Include code snippets when relevant +- Specify assignees if known +- Set appropriate priorities +- Add deadlines or milestones if applicable + +For more detailed information about issue tracking integrations, see our [Issue Integrations](../integrations/issue-integrations.md) guide. diff --git a/docs/integrations/issue-integrations.md b/docs/integrations/issue-integrations.md index 774378b8..a153839b 100644 --- a/docs/integrations/issue-integrations.md +++ b/docs/integrations/issue-integrations.md @@ -37,13 +37,15 @@ To link a Jira Issue, you can add the Jira Issue into the PR description as show Closes CR-5 ``` +You can also create new Jira issues directly through CodeRabbit. See our [Issue Creation guide](../guides/issue-creation.md#jira) for details. + ## Linear {#Linear} ```mdx-code-block ``` -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. +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. ### CodeRabbit App @@ -67,6 +69,8 @@ To link a Linear Issue, you can add the Linear Issue via the team key and issue Closes ENG-123 ``` +You can also create new Linear issues directly through CodeRabbit. Learn more in our [Issue Creation guide](../guides/issue-creation.md#linear). + ## GitHub ```mdx-code-block diff --git a/static/img/guides/create-issue-agentic.png b/static/img/guides/create-issue-agentic.png new file mode 100644 index 00000000..286ee490 Binary files /dev/null and b/static/img/guides/create-issue-agentic.png differ diff --git a/static/img/guides/create-issue-inline.png b/static/img/guides/create-issue-inline.png new file mode 100644 index 00000000..873df82f Binary files /dev/null and b/static/img/guides/create-issue-inline.png differ