chore: Add Jira issue templates#55
Conversation
Add markdown templates with YAML metadata for Epic, Story, Task, Bug, and Spike issue types. Templates follow the team playbook conventions and include default field values for project, component, team, and activity type. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
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 (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds six new files under Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
nickommen
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.jira/templates/epic.md:
- Around line 13-14: Replace the empty required Epic field value by providing a
non-empty placeholder for customfield_12311141 (e.g., "TBD Epic Name" or "Epic
Name - TODO") so Epic creation won't fail when tooling doesn't override it;
update the template entry for customfield_12311141 to a sensible default string
and ensure any docs/comments note it should be replaced when creating real
Epics.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d45ba6c5-246f-4a6e-aef2-7821e90bfec9
📒 Files selected for processing (5)
.jira/templates/bug.md.jira/templates/epic.md.jira/templates/spike.md.jira/templates/story.md.jira/templates/task.md
| # Epic Name (required for Epics) | ||
| customfield_12311141: "" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Verify whether any template leaves required Epic Name empty.
python - <<'PY'
from pathlib import Path
import re, sys
try:
import yaml
except Exception:
print("PyYAML not installed. Install with: pip install pyyaml")
sys.exit(2)
p = Path(".jira/templates/epic.md")
txt = p.read_text(encoding="utf-8")
m = re.match(r"^---\n(.*?)\n---\n", txt, re.S)
if not m:
print("[FAIL] epic.md missing frontmatter")
sys.exit(1)
data = yaml.safe_load(m.group(1))
value = data.get("fields", {}).get("customfield_12311141", None)
if value == "":
print("[FAIL] customfield_12311141 is empty string")
sys.exit(1)
print("[OK] customfield_12311141 is non-empty:", value)
PYRepository: red-hat-data-services/agentic-starter-kits
Length of output: 129
🏁 Script executed:
# Find all Jira template files and check for empty customfield entries
find .jira/templates -type f -name "*.md" | while read f; do
echo "=== $f ==="
grep -E "customfield_[0-9]+:\s*\"\"" "$f" || echo "(no empty customfields)"
doneRepository: red-hat-data-services/agentic-starter-kits
Length of output: 369
🏁 Script executed:
# Check for documentation about template usage and field requirements
fd -t f -e md -e txt -e yaml . | xargs grep -l "customfield_12311141\|Epic Name\|template" 2>/dev/null | head -20Repository: red-hat-data-services/agentic-starter-kits
Length of output: 739
🏁 Script executed:
# Search for any comments or docs about required fields in templates
find .jira -type f \( -name "*.md" -o -name "*.txt" -o -name "*.yaml" \) -exec grep -l "required" {} \;Repository: red-hat-data-services/agentic-starter-kits
Length of output: 133
🏁 Script executed:
# Read the epic.md template to see full structure
cat -n .jira/templates/epic.mdRepository: red-hat-data-services/agentic-starter-kits
Length of output: 1626
🏁 Script executed:
# Read task.md to compare how "required" is mentioned
cat -n .jira/templates/task.mdRepository: red-hat-data-services/agentic-starter-kits
Length of output: 1372
🏁 Script executed:
# Search for any usage or documentation about this field being required
rg "customfield_12311141|Epic.*Name.*required" --type md --type yamlRepository: red-hat-data-services/agentic-starter-kits
Length of output: 68
Replace the empty Epic Name field with a non-empty placeholder.
The template sets customfield_12311141 to an empty string on line 14, but it is marked required for Epics. This will cause Epic creation to fail if the field is not overridden by calling tooling.
Suggested fix
- # Epic Name (required for Epics)
- customfield_12311141: ""
+ # Epic Name (required for Epics) - replace before creating issue
+ customfield_12311141: "[REQUIRED] Set Epic Name"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Epic Name (required for Epics) | |
| customfield_12311141: "" | |
| # Epic Name (required for Epics) - replace before creating issue | |
| customfield_12311141: "[REQUIRED] Set Epic Name" |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.jira/templates/epic.md around lines 13 - 14, Replace the empty required
Epic field value by providing a non-empty placeholder for customfield_12311141
(e.g., "TBD Epic Name" or "Epic Name - TODO") so Epic creation won't fail when
tooling doesn't override it; update the template entry for customfield_12311141
to a sensible default string and ensure any docs/comments note it should be
replaced when creating real Epics.
Correct field IDs validated against the live RHAIENG Jira API: - Team: customfield_12313240 -> customfield_10001 (plain string ID) - Activity Type: customfield_12320841 -> customfield_10464 (id+value) - Remove Epic Name field (not required, auto-populated from Summary) Change checkboxes to numbered lists for Jira compatibility and promote headings from h3 to h2. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.jira/templates/story.md (1)
24-24: Consider simplifying "prior to" to "before".The phrase "prior to" can be simplified to "before" for more concise text.
✏️ Proposed simplification
-[Briefly explain the technical plan, framework integration, or architecture changes. To be drafted by the Feature Shepherd prior to refinement.] +[Briefly explain the technical plan, framework integration, or architecture changes. To be drafted by the Feature Shepherd before refinement.]🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.jira/templates/story.md at line 24, Replace the phrase "prior to refinement" with the simpler "before refinement" in the template sentence "[Briefly explain the technical plan, framework integration, or architecture changes. To be drafted by the Feature Shepherd prior to refinement.]" so the line reads "...To be drafted by the Feature Shepherd before refinement." Ensure only this wording is changed and preserve the rest of the sentence.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.jira/templates/story.md:
- Line 24: Replace the phrase "prior to refinement" with the simpler "before
refinement" in the template sentence "[Briefly explain the technical plan,
framework integration, or architecture changes. To be drafted by the Feature
Shepherd prior to refinement.]" so the line reads "...To be drafted by the
Feature Shepherd before refinement." Ensure only this wording is changed and
preserve the rest of the sentence.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: f6689919-995e-4cc2-a51c-e163b62b6111
📒 Files selected for processing (5)
.jira/templates/bug.md.jira/templates/epic.md.jira/templates/spike.md.jira/templates/story.md.jira/templates/task.md
✅ Files skipped from review due to trivial changes (4)
- .jira/templates/task.md
- .jira/templates/epic.md
- .jira/templates/spike.md
- .jira/templates/bug.md
|
@mpk-droid @tarun-etikala @kami619 Can I get a review? |
|
not blocking this PR. Something to remember for future:These templates looks solid But we don't currently have anything linking these to claude.md. For humans, we could also consider updating root level README.md for discoverability. |
|
|
||
| ## Expected Artifacts | ||
|
|
||
| [Check the expected outputs of this investigation.] |
There was a problem hiding this comment.
nit: Since the list below is numbered, we can't check anything. Either convert those to checkboxes or we can say "list the expected outputs.."
There was a problem hiding this comment.
The checkboxes don't look to be standard Markdown in Jira, but in ADF. I'll change the instructions.
| components: | ||
| - name: Tooling Experience | ||
| # Team (Tooling Experience) | ||
| customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611" |
There was a problem hiding this comment.
All other templates has Activity Type. Is this intentionally left out for epics?
There was a problem hiding this comment.
Correct. We only need it set for issues at the level below epics.
added few comments. lmk what you think |
|
Really good starting point for using the templates. The integration layer between these templates and Claude is missing. Would suggest to have Some future work to improve this:
|
|
looks like a good starting point and agree with both @tarun-etikala and @mpk-droid suggestions., real road test would be to try this out to create the issues., but with JIRA MCP service unavailable, we could do that down the line. This is an awesome first step @nickommen 🥇 |
- Add .jira/README describing templates, roles, and YAML front matter. - Spike template: reword Expected Artifacts placeholder for clearer intent. Made-with: Cursor
|
Thanks for the feedback! I added a |
tarun-etikala
left a comment
tarun-etikala
left a comment
There was a problem hiding this comment.
LGTM
(For the future PR)A one-liner in AGENTS.md under a "Jira" section would help agents discover this:
## Jira Templates
- `.jira/templates/` contains issue templates (Epic, Story, Task, Bug, Spike) for RHAIENG
4 participants
Summary
.jira/templates/Test plan
🤖 Generated with Claude Code