@@ -26,6 +26,17 @@ Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira log
2626
27271 . Add Jira's Project Keys to the` knowledge_base.jira.project_keys ` field in your project's CodeRabbit configuration file at` .coderabbit.yaml ` .
2828
29+ ###Example Usage
30+
31+ You can link an issue to your pull request, allowing CodeRabbit to assess whether your changes satisfy the issue's requirements.
32+
33+ To link a Jira Issue, you can add the Jira Issue into the PR description as shown below.
34+
35+ ``` text
36+ // (Jira Project Key - Issue Number)
37+ Closes CR-5
38+ ```
39+
2940##Linear {#Linear}
3041
3142``` mdx-code-block
@@ -44,3 +55,29 @@ Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear
44551 . Add Linear's Team Keys to the` knowledge_base.linear.team_keys ` field in your project's CodeRabbit configuration file at` .coderabbit.yaml ` .
4556
4657[ integrations ] :https://app.coderabbit.ai/integrations
58+
59+ ###Example Usage
60+
61+ 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.
62+
63+ ``` text
64+ // (Linear Team Key - Issue Number)
65+ Closes ENG-123
66+ ```
67+
68+ ##GitHub
69+
70+ ``` mdx-code-block
71+ <ProPlanNotice />
72+ ```
73+
74+ GitHub issue integration works automatically without any additional setup required.
75+
76+ ###Example Usage
77+
78+ To link a GitHub Issue, you can add the issue into the PR description as shown below.
79+
80+ ``` text
81+ // (# GitHub Issue Number)
82+ Closes #123
83+ ```