docs: document Jira + GitHub PR linking integration#88
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughUpdated repository documentation to make Jira ticket linkage explicit: the PR template now requires a Jira ticket ID, and CONTRIBUTING.md adds a “Linking PRs to Jira” section and wraps example blocks in fenced code blocks. ChangesJira Linking Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsTimed out fetching pipeline failures after 30000ms Review rate limit: 9/10 reviews remaining, refill in 6 minutes. Comment |
Add guidance on how Jira ticket IDs in PR titles, branch names, or the PR template field auto-link pull requests to Jira issues. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
tarun-etikala
force-pushed
the
docs/jira-github-integration
branch
from
5bbbea2 to
0b1b206
Compare
Fixes markdownlint MD040 violations on two code blocks missing language identifiers (commit message format template and breaking change example). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
||
| ## Linking PRs to Jira | ||
|
|
||
| This repository has GitHub + Jira integration enabled. When you include a Jira ticket ID (e.g. `RHAIENG-123`) in your PR title, branch name, or the **Jira Ticket** field in the PR template, the pull request automatically appears under **Development** on the Jira issue. This gives the visibility into which tickets have active or merged code without leaving Jira. |
There was a problem hiding this comment.
nit: The Jira ticket (RHAIENG-4115) lists commit messages as another place where the integration matches issue keys. Consider adding "commit messages" to the list here. Also, "the Jira Ticket field in the PR template" is slightly imprecise — the integration scans the visible PR description body, not the HTML comment placeholder. Saying "PR description" would be more accurate.
Assisted by Claude Opus 4.6 (1M context)
|
|
||
| ## Linking PRs to Jira | ||
|
|
||
| This repository has GitHub + Jira integration enabled. When you include a Jira ticket ID (e.g. `RHAIENG-123`) in your PR title, branch name, or the **Jira Ticket** field in the PR template, the pull request automatically appears under **Development** on the Jira issue. This gives the visibility into which tickets have active or merged code without leaving Jira. |
There was a problem hiding this comment.
nit: "This gives the visibility" → "This gives visibility" (drop "the").
Assisted by Claude Opus 4.6 (1M context)
mpk-droid
left a comment
mpk-droid
left a comment
There was a problem hiding this comment.
LGTM. Added non-blocking/minor comments
Add commit messages to the list of places Jira scans, use "PR
description" instead of "Jira Ticket field in the PR template",
and fix grammar ("the visibility" → "visibility").
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2 participants
Description
Adds documentation for the Jira + GitHub integration that shows linked PRs on Jira issues. Updates CONTRIBUTING.md with a new "Linking PRs to Jira" section and clarifies the Jira Ticket field in the PR template.
Jira Ticket
RHAIENG-4115
Testing
Checklist
.envor secret files are included in this PRReview Guidance
Documentation-only change — two files affected:
CONTRIBUTING.md— new "Linking PRs to Jira" section after "Commit message conventions".github/PULL_REQUEST_TEMPLATE.md— expanded comment on the Jira Ticket fieldRelated PRs