From 3d7e292e67714575ec714488d04e67bebcad851c Mon Sep 17 00:00:00 2001 From: karan Date: Wed, 22 Jan 2025 13:16:01 -0800 Subject: [PATCH 1/2] Update docs on issue integration --- docs/integrations/issue-integrations.md | 37 +++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/integrations/issue-integrations.md b/docs/integrations/issue-integrations.md index fc139b0b..c1f73d25 100644 --- a/docs/integrations/issue-integrations.md +++ b/docs/integrations/issue-integrations.md @@ -26,6 +26,17 @@ Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira log 1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. +### Example Usage + +Inside your pull request, you can include a issue to for CodeRabbit to perform an assessment and validate if the code satisfies the requirements of the issue. + +To link a Jira Issue, you can add the Jira Issue into the PR description. + +```text +// (Jira Project Key - Issue Number) +Closes CR-5 +``` + ## Linear {#Linear} ```mdx-code-block @@ -44,3 +55,29 @@ Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear 1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. [integrations]: https://app.coderabbit.ai/integrations + +### Example Usage + +To link a Linear Issue, you can add the Linear Issue via team key and issue number into the PR description. + +```text +// (Linear Team Key - Issue Number) +Closes ENG-123 +``` + +## GitHub + +```mdx-code-block + +``` + +GitHub issue integration works automatically without any additional setup required. + +### Example Usage + +To link a GitHub Issue, you can add the issue into the PR description. + +```text +// (# GitHub Issue Number) +Closes #123 +``` From 006f78105a7a1e22d7b09886fe5d041acafc7944 Mon Sep 17 00:00:00 2001 From: karan Date: Wed, 22 Jan 2025 13:18:54 -0800 Subject: [PATCH 2/2] Minor fixes --- docs/integrations/issue-integrations.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/integrations/issue-integrations.md b/docs/integrations/issue-integrations.md index c1f73d25..11562df3 100644 --- a/docs/integrations/issue-integrations.md +++ b/docs/integrations/issue-integrations.md @@ -28,9 +28,9 @@ Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira log ### Example Usage -Inside your pull request, you can include a issue to for CodeRabbit to perform an assessment and validate if the code satisfies the requirements of the issue. +You can link an issue to your pull request, allowing CodeRabbit to assess whether your changes satisfy the issue's requirements. -To link a Jira Issue, you can add the Jira Issue into the PR description. +To link a Jira Issue, you can add the Jira Issue into the PR description as shown below. ```text // (Jira Project Key - Issue Number) @@ -58,7 +58,7 @@ Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear ### Example Usage -To link a Linear Issue, you can add the Linear Issue via team key and issue number into the PR description. +To link a Linear Issue, you can add the Linear Issue via the team key and issue number into the PR description as shown below. ```text // (Linear Team Key - Issue Number) @@ -75,7 +75,7 @@ GitHub issue integration works automatically without any additional setup requir ### Example Usage -To link a GitHub Issue, you can add the issue into the PR description. +To link a GitHub Issue, you can add the issue into the PR description as shown below. ```text // (# GitHub Issue Number)