Update issue integrations #207
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis pull request updates the documentation for issue integrations, specifically focusing on the "Example Usage" sections for Jira, Linear, and GitHub integrations. The changes provide clear, practical examples of how to link issues to pull requests using specific formatting conventions. These additions aim to help users understand the correct way to reference and close issues when creating pull requests across different issue tracking platforms. Changes
Possibly related PRs
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
006f781
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a5475c61.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://update-issue-integrations.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/integrations/issue-integrations.md (4)
29-38: Enhance the Jira example usage section with additional details.Consider adding the following information to make the documentation more comprehensive:
- List all supported keywords (e.g., "Fixes", "Resolves")
- Show how to link multiple Jira issues
- Clarify that "CR" is just an example project key
### Example Usage 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 as shown below. ```text -// (Jira Project Key - Issue Number) -Closes CR-5 +// Link a single issue (replace PROJECT with your Jira project key) +Closes PROJECT-123 + +// Supported keywords +Fixes PROJECT-123 +Resolves PROJECT-123 + +// Link multiple issues +Closes PROJECT-123, PROJECT-456--- `59-66`: **Maintain consistency with Jira section and add more examples.** The Linear example should follow the same pattern as the Jira section for consistency. Also, consider adding similar additional details. ```diff ### Example Usage -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. +You can link an issue to your pull request, allowing CodeRabbit to assess whether your changes satisfy the issue's requirements. + +To link a Linear Issue, you can add the Linear Issue into the PR description as shown below. ```text -// (Linear Team Key - Issue Number) -Closes ENG-123 +// Link a single issue (replace TEAM with your Linear team key) +Closes TEAM-123 + +// Supported keywords +Fixes TEAM-123 +Resolves TEAM-123 + +// Link multiple issues +Closes TEAM-123, TEAM-456--- `74-83`: **Add GitHub-specific features and maintain consistency with other sections.** The GitHub section should include GitHub-specific features like cross-repository references while maintaining consistency with other sections. ```diff 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 as shown below. +You can link an issue to your pull request, allowing CodeRabbit to assess whether your changes satisfy the issue's requirements. + +To link a GitHub Issue, you can add the issue into the PR description as shown below. ```text -// (# GitHub Issue Number) -Closes #123 +// Link a single issue +Closes #123 + +// Supported keywords +Fixes #123 +Resolves #123 + +// Link multiple issues +Closes #123, #456 + +// Link issues from different repositories +Closes owner/repo#123--- Line range hint `29-83`: **Consider restructuring the document for better organization.** The documentation would benefit from a more consistent structure across all integration sections. Consider following this pattern for each integration: 1. Introduction 2. Setup Requirements (if any) 3. Example Usage - Basic Usage - Supported Keywords - Multiple Issues - Platform-specific Features This would make the documentation more scannable and easier to maintain. </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 806a1aa80d89b83c6dd3367c20caeceedfb2eab3 and 006f78105a7a1e22d7b09886fe5d041acafc7944. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/integrations/issue-integrations.md` (2 hunks) </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms (1)</summary> * GitHub Check: Cloudflare Pages </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.