Skip to content

Commit 07331fe

Browse files
nickommenclaude
nickommen
and
claude
authored
chore: Add Jira issue templates (red-hat-data-services#55)
* Add Jira issue templates for RHAIENG project 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> * Fix custom field IDs and formatting in Jira templates 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> * docs(jira): add README and clarify spike expected artifacts - Add .jira/README describing templates, roles, and YAML front matter. - Spike template: reword Expected Artifacts placeholder for clearer intent. Made-with: Cursor --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 94446ca commit 07331fe

6 files changed

Lines changed: 213 additions & 0 deletions

File tree

‎.jira/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Jira Issue Templates
2+
3+
This folder holds **Markdown issue templates** for planning and tracking work in Jira. Each file under `templates/` is a reusable blueprint: YAML front matter sets default **project** (`RHAIENG`), **issue type**, **component** (Tooling Experience), **team**, and where applicable **activity type** custom fields; the body is placeholder sections you fill before creating or pasting into a ticket.
4+
5+
## `templates/`
6+
7+
| File | Issue type | Role |
8+
|------|------------|------|
9+
| `epic.md` | Epic | Large outcomes: business objective, technical approach, dependencies, epic-level acceptance criteria, and a shepherd checklist for breaking work into child issues. |
10+
| `story.md` | Story | User-facing capability: value statement, approach, acceptance criteria (local + RHOAI + docs), testing strategy. Defaults to activity type **New Features**. |
11+
| `task.md` | Task | Internal engineering work: goal, approach, regression risk, acceptance criteria, testing strategy. Defaults to activity type **Tech Debt & Quality**. |
12+
| `bug.md` | Bug | Defects: description, repro steps, expected vs actual, workaround, impact, dependency chain, acceptance criteria, testing strategy. Same default activity type as tasks. |
13+
| `spike.md` | Spike | Time-boxed research: objective, time-box, expected artifacts (design/POC/follow-on tickets). Defaults to activity type **Learning & Enablement**. |
14+
15+
## Usage
16+
17+
Copy the template that matches the work item, replace bracketed placeholders, and create the issue in Jira (or use your team’s import/automation if it consumes this front matter format). If you reuse this repo outside the original Jira project, edit the **YAML front matter** at the top of that template file and change `project`, `components`, Team Id (`customfield_10001`), and where present Activity Type (`customfield_10464`) to match your Jira instance.

‎.jira/templates/bug.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
# Jira Issue Template: Bug
3+
type: Bug
4+
project: RHAIENG
5+
fields:
6+
issuetype:
7+
name: Bug
8+
components:
9+
- name: Tooling Experience
10+
# Team (Tooling Experience)
11+
customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611"
12+
# Activity Type
13+
customfield_10464:
14+
id: "12228"
15+
value: Tech Debt & Quality
16+
---
17+
18+
## Description
19+
20+
[Brief summary of the broken functionality. e.g., LangGraph ReAct agent example fails on RHOAI due to deprecated API call.]
21+
22+
## Steps to Reproduce
23+
24+
1. [Step 1]
25+
2. [Step 2]
26+
3. [Step 3]
27+
28+
## Expected Outcome
29+
30+
[What should have happened?]
31+
32+
## Actual Outcome
33+
34+
[What actually happened? Include logs, error messages, or stack traces.]
35+
36+
## Workaround
37+
38+
[Is there a temporary way to bypass this issue? If none, state "None".]
39+
40+
## Impact
41+
42+
[Who is affected and how severely? e.g., All users following the CrewAI quickstart cannot complete the deployment step.]
43+
44+
## Dependency Chain
45+
46+
[Explicitly call out any upstream framework bugs or RHOAI platform issues blocking this fix. If none, state "None".]
47+
48+
## Acceptance Criteria
49+
50+
1. Bug cannot be reproduced using the steps above
51+
2. Example runs successfully locally and on RHOAI
52+
3. CI/CD pipeline passes
53+
54+
## Testing Strategy
55+
56+
[Describe how the functionality will be tested and automated. Note areas requiring manual or complex testing that should be considered during story pointing and code review.]

‎.jira/templates/epic.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
# Jira Issue Template: Epic
3+
type: Epic
4+
project: RHAIENG
5+
fields:
6+
issuetype:
7+
name: Epic
8+
components:
9+
- name: Tooling Experience
10+
# Team (Tooling Experience)
11+
customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611"
12+
---
13+
14+
## Business Objective
15+
16+
[State the overarching goal, customer need, or framework capability being delivered. e.g., Deliver an E2E agentic example using CrewAI with tool-calling on RHOAI.]
17+
18+
## Technical Approach
19+
20+
[High-level architecture or technical plan drafted by the Feature Shepherd. Include target framework, deployment pattern (local + RHOAI), and any POC links.]
21+
22+
## External Dependencies
23+
24+
[List any cross-team dependencies, upstream framework blockers, or RHOAI platform requirements. If none, state "None".]
25+
26+
## Epic Acceptance Criteria
27+
28+
1. E2E example is functional locally and deployed on RHOAI
29+
2. Documentation and README are complete and reviewed
30+
3. CI/CD pipeline passes for the example
31+
32+
## Shepherd Breakdown Checklist
33+
34+
1. Epic is broken down into properly sized Stories, Tasks, and Spikes.
35+
2. Child tickets meet the Definition of Ready (clear intent, AC defined, pointed).
36+
3. Work is delegated across the team to build shared expertise and prevent knowledge silos.

‎.jira/templates/spike.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
# Jira Issue Template: Spike
3+
type: Spike
4+
project: RHAIENG
5+
fields:
6+
issuetype:
7+
name: Spike
8+
components:
9+
- name: Tooling Experience
10+
# Team (Tooling Experience)
11+
customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611"
12+
# Activity Type
13+
customfield_10464:
14+
id: "12230"
15+
value: Learning & Enablement
16+
---
17+
18+
## Objective
19+
20+
[State the specific question we need to answer or the unknown we are researching. e.g., Evaluate whether AutoGen supports tool-calling patterns compatible with our RHOAI deployment model.]
21+
22+
## Time-Box
23+
24+
[State the maximum amount of effort to spend before stopping. e.g., 2 days.]
25+
26+
## Expected Artifacts
27+
28+
[List the expected outputs of this investigation.]
29+
30+
1. Design document or technical plan
31+
2. Proof of Concept (POC) or Draft PR
32+
3. New Jira tickets created and broken down for upcoming sprints

‎.jira/templates/story.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
# Jira Issue Template: Story
3+
type: Story
4+
project: RHAIENG
5+
fields:
6+
issuetype:
7+
name: Story
8+
components:
9+
- name: Tooling Experience
10+
# Team (Tooling Experience)
11+
customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611"
12+
# Activity Type
13+
customfield_10464:
14+
id: "12229"
15+
value: New Features
16+
---
17+
18+
## Value Statement
19+
20+
[State the capability or experience improvement being delivered to AI Engineers. e.g., Add MLflow tracing to the existing LangGraph ReAct agent example.]
21+
22+
## Proposed Approach
23+
24+
[Briefly explain the technical plan, framework integration, or architecture changes. To be drafted by the Feature Shepherd prior to refinement.]
25+
26+
## Acceptance Criteria
27+
28+
1. Example runs successfully in a local development environment
29+
2. Example deploys and runs successfully on RHOAI
30+
3. README documents setup, usage, and expected output
31+
32+
## Testing Strategy
33+
34+
[Describe how the functionality will be tested and automated. Note areas requiring manual or complex testing that should be considered during story pointing and code review.]

‎.jira/templates/task.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
# Jira Issue Template: Task
3+
type: Task
4+
project: RHAIENG
5+
fields:
6+
issuetype:
7+
name: Task
8+
components:
9+
- name: Tooling Experience
10+
# Team (Tooling Experience)
11+
customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611"
12+
# Activity Type
13+
customfield_10464:
14+
id: "12228"
15+
value: Tech Debt & Quality
16+
---
17+
18+
## Goal
19+
20+
[State the internal engineering goal. e.g., Add linting and unit test jobs to the CI/CD pipeline for all LangChain examples.]
21+
22+
## Proposed Approach
23+
24+
[Briefly outline the technical steps or implementation plan required to complete this work.]
25+
26+
## Regression Risk
27+
28+
[Identify what might accidentally break because of this change and how we will mitigate it.]
29+
30+
## Acceptance Criteria
31+
32+
1. Pipeline or automation executes successfully
33+
2. Existing examples and tests pass without regressions
34+
3. Specific internal outcome is achieved
35+
36+
## Testing Strategy
37+
38+
[Describe how the functionality will be tested and automated. Note areas requiring manual or complex testing that should be considered during story pointing and code review.]

0 commit comments

Comments
 (0)