Skip to content

Commit 961adbc

Browse files
committed
Update Jira and Linear integration documentation
1 parent a650e04 commit 961adbc

File tree

2 files changed

+32
-5
lines changed

2 files changed

+32
-5
lines changed

docs/integrations/Jira/link.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Utilize CodeRabbit with Jira
2+
title: Jira Integration
33
description: Integrate CodeRabbit with Jira.
44
sidebar_label: Linked and Related Issues
55
image: "/preview_meta.jpg"
@@ -26,22 +26,21 @@ image: "/preview_meta.jpg"
2626

2727
After successfully integrating CodeRabbit with Jira, you gain the ability to link Jira issues directly to your pull requests.
2828

29-
Linking Issues with Pull Requests
3029
To link a Jira issue to a pull request, simply include the Jira Issue ID in the pull request description. For instance:
3130

3231
Jira issue: TEK-01
3332

3433
This indicates that the pull request addresses a specific issue, such as fixing a bug. When the pull request is submitted with the associated Jira Issue ID, CodeRabbit automatically retrieves the corresponding issue and evaluates whether the pull request fulfills its objectives.
3534

3635
:::info
37-
You can view the assessment outcome in the Walkthrough section.
36+
You can view the assessment outcome in the Walkthrough section of CodeRabbit's Review
3837
:::
3938

4039
Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed.
4140

4241
### Finding Related Issues
4342

44-
One of the key features of CodeRabbit's Jira integration is its ability to discover related issues. Leveraging RAG (Retrieval-Augmented Generation), CodeRabbit enhances its AI capabilities. RAG empowers AI models to incorporate external data sources beyond their training sets or predefined parameters, thereby enhancing their responses to given prompts.
43+
One of the key features of CodeRabbit's Jira integration is its ability to discover existing related jira issues addressed in the pull request. Leveraging RAG (Retrieval-Augmented Generation), CodeRabbit enhances its AI capabilities. RAG empowers AI models to incorporate external data sources beyond their training sets or predefined parameters, thereby enhancing their responses to given prompts.
4544

4645
After integrating with Jira, CodeRabbit scans through open issues, indexing them for future reference. This means that pre-existing issues are retrieved, indexed into a Vector database, and subsequently searched for each new pull request.
4746

docs/integrations/Linear/link.md

+29-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Utilize CodeRabbit with Linear
2+
title: Linear Integration
33
description: Utilize CodeRabbit with Linear.
44
sidebar_label: Linked and Related Issues
55
image: "/preview_meta.jpg"
@@ -21,3 +21,31 @@ image: "/preview_meta.jpg"
2121
<meta name="twitter:title" content="Utilize CodeRabbit with Linear" />
2222
<meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" />
2323
</head>
24+
25+
### Linking Issues
26+
27+
After successfully integrating CodeRabbit with Linear, you gain the ability to link Linear issues directly to your pull requests.
28+
29+
To link a Linear issue to a pull request, simply include the Linear Issue ID in the pull request description.
30+
31+
For instance:
32+
33+
Linear issue: **_COD-86_**
34+
35+
![Linear Issue](../images/Linear/link/linear-linked-issue.png)
36+
37+
This indicates that the pull request addresses a specific issue, such as adding a new feature. In this simple example, the issue created on linear specified to implement the division functionality for the simple calculator.
38+
39+
When the pull request is submitted with the associated Linear Issue ID, CodeRabbit automatically retrieves the corresponding issue and evaluates whether the pull request fulfills its objectives.
40+
41+
:::info
42+
You can view the assessment outcome in the Walkthrough section of CodeRabbit's Review.
43+
:::
44+
45+
Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. For example here the developer added the division functionality for the simple calculator in the pull request. CodeRabbit was able to find that issue, assess whether the pull request did indeed resolve the issue, and provided the assessment as seen below.
46+
47+
![Linear Issue Response](../images/Linear/link/linear-assessment.png)
48+
49+
### Finding Related Issues
50+
51+
Another key feature of CodeRabbit's Linear integration is its ability to discover existing related Linear issues addressed in a pull request. Leveraging RAG (Retrieval-Augmented Generation) as described in [Jira Integration - Finding Related Issues](../Jira/link#finding-related-issues)

0 commit comments

Comments
 (0)