-
Notifications
You must be signed in to change notification settings - Fork 12
chore: Add Jira issue templates #55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
tarun-etikala
merged 4 commits into
red-hat-data-services:main
from
nickommen:jira-templates
Apr 29, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6cacb1f
Add Jira issue templates for RHAIENG project
nickommen 6a17ff8
Fix custom field IDs and formatting in Jira templates
nickommen 75d9daf
Merge branch 'red-hat-data-services:main' into jira-templates
nickommen b2287d0
docs(jira): add README and clarify spike expected artifacts
nickommen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Jira Issue Templates | ||
|
|
||
| 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. | ||
|
|
||
| ## `templates/` | ||
|
|
||
| | File | Issue type | Role | | ||
| |------|------------|------| | ||
| | `epic.md` | Epic | Large outcomes: business objective, technical approach, dependencies, epic-level acceptance criteria, and a shepherd checklist for breaking work into child issues. | | ||
| | `story.md` | Story | User-facing capability: value statement, approach, acceptance criteria (local + RHOAI + docs), testing strategy. Defaults to activity type **New Features**. | | ||
| | `task.md` | Task | Internal engineering work: goal, approach, regression risk, acceptance criteria, testing strategy. Defaults to activity type **Tech Debt & Quality**. | | ||
| | `bug.md` | Bug | Defects: description, repro steps, expected vs actual, workaround, impact, dependency chain, acceptance criteria, testing strategy. Same default activity type as tasks. | | ||
| | `spike.md` | Spike | Time-boxed research: objective, time-box, expected artifacts (design/POC/follow-on tickets). Defaults to activity type **Learning & Enablement**. | | ||
|
|
||
| ## Usage | ||
|
|
||
| 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. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| # Jira Issue Template: Bug | ||
| type: Bug | ||
| project: RHAIENG | ||
| fields: | ||
| issuetype: | ||
| name: Bug | ||
| components: | ||
| - name: Tooling Experience | ||
| # Team (Tooling Experience) | ||
| customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611" | ||
| # Activity Type | ||
| customfield_10464: | ||
| id: "12228" | ||
| value: Tech Debt & Quality | ||
| --- | ||
|
|
||
| ## Description | ||
|
|
||
| [Brief summary of the broken functionality. e.g., LangGraph ReAct agent example fails on RHOAI due to deprecated API call.] | ||
|
|
||
| ## Steps to Reproduce | ||
|
|
||
| 1. [Step 1] | ||
| 2. [Step 2] | ||
| 3. [Step 3] | ||
|
|
||
| ## Expected Outcome | ||
|
|
||
| [What should have happened?] | ||
|
|
||
| ## Actual Outcome | ||
|
|
||
| [What actually happened? Include logs, error messages, or stack traces.] | ||
|
|
||
| ## Workaround | ||
|
|
||
| [Is there a temporary way to bypass this issue? If none, state "None".] | ||
|
|
||
| ## Impact | ||
|
|
||
| [Who is affected and how severely? e.g., All users following the CrewAI quickstart cannot complete the deployment step.] | ||
|
|
||
| ## Dependency Chain | ||
|
|
||
| [Explicitly call out any upstream framework bugs or RHOAI platform issues blocking this fix. If none, state "None".] | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| 1. Bug cannot be reproduced using the steps above | ||
| 2. Example runs successfully locally and on RHOAI | ||
| 3. CI/CD pipeline passes | ||
|
|
||
| ## Testing Strategy | ||
|
|
||
| [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.] |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| # Jira Issue Template: Epic | ||
| type: Epic | ||
| project: RHAIENG | ||
| fields: | ||
| issuetype: | ||
| name: Epic | ||
| components: | ||
| - name: Tooling Experience | ||
| # Team (Tooling Experience) | ||
| customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611" | ||
| --- | ||
|
|
||
| ## Business Objective | ||
|
|
||
| [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.] | ||
|
|
||
| ## Technical Approach | ||
|
|
||
| [High-level architecture or technical plan drafted by the Feature Shepherd. Include target framework, deployment pattern (local + RHOAI), and any POC links.] | ||
|
|
||
| ## External Dependencies | ||
|
|
||
| [List any cross-team dependencies, upstream framework blockers, or RHOAI platform requirements. If none, state "None".] | ||
|
|
||
| ## Epic Acceptance Criteria | ||
|
|
||
| 1. E2E example is functional locally and deployed on RHOAI | ||
| 2. Documentation and README are complete and reviewed | ||
| 3. CI/CD pipeline passes for the example | ||
|
|
||
| ## Shepherd Breakdown Checklist | ||
|
|
||
| 1. Epic is broken down into properly sized Stories, Tasks, and Spikes. | ||
| 2. Child tickets meet the Definition of Ready (clear intent, AC defined, pointed). | ||
| 3. Work is delegated across the team to build shared expertise and prevent knowledge silos. | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| # Jira Issue Template: Spike | ||
| type: Spike | ||
| project: RHAIENG | ||
| fields: | ||
| issuetype: | ||
| name: Spike | ||
| components: | ||
| - name: Tooling Experience | ||
| # Team (Tooling Experience) | ||
| customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611" | ||
| # Activity Type | ||
| customfield_10464: | ||
| id: "12230" | ||
| value: Learning & Enablement | ||
| --- | ||
|
|
||
| ## Objective | ||
|
|
||
| [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.] | ||
|
|
||
| ## Time-Box | ||
|
|
||
| [State the maximum amount of effort to spend before stopping. e.g., 2 days.] | ||
|
|
||
| ## Expected Artifacts | ||
|
|
||
| [List the expected outputs of this investigation.] | ||
|
|
||
| 1. Design document or technical plan | ||
| 2. Proof of Concept (POC) or Draft PR | ||
| 3. New Jira tickets created and broken down for upcoming sprints |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| # Jira Issue Template: Story | ||
| type: Story | ||
| project: RHAIENG | ||
| fields: | ||
| issuetype: | ||
| name: Story | ||
| components: | ||
| - name: Tooling Experience | ||
| # Team (Tooling Experience) | ||
| customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611" | ||
| # Activity Type | ||
| customfield_10464: | ||
| id: "12229" | ||
| value: New Features | ||
| --- | ||
|
|
||
| ## Value Statement | ||
|
|
||
| [State the capability or experience improvement being delivered to AI Engineers. e.g., Add MLflow tracing to the existing LangGraph ReAct agent example.] | ||
|
|
||
| ## Proposed Approach | ||
|
|
||
| [Briefly explain the technical plan, framework integration, or architecture changes. To be drafted by the Feature Shepherd prior to refinement.] | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| 1. Example runs successfully in a local development environment | ||
| 2. Example deploys and runs successfully on RHOAI | ||
| 3. README documents setup, usage, and expected output | ||
|
|
||
| ## Testing Strategy | ||
|
|
||
| [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.] |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| # Jira Issue Template: Task | ||
| type: Task | ||
| project: RHAIENG | ||
| fields: | ||
| issuetype: | ||
| name: Task | ||
| components: | ||
| - name: Tooling Experience | ||
| # Team (Tooling Experience) | ||
| customfield_10001: "ec74d716-af36-4b3c-950f-f79213d08f71-1611" | ||
| # Activity Type | ||
| customfield_10464: | ||
| id: "12228" | ||
| value: Tech Debt & Quality | ||
| --- | ||
|
|
||
| ## Goal | ||
|
|
||
| [State the internal engineering goal. e.g., Add linting and unit test jobs to the CI/CD pipeline for all LangChain examples.] | ||
|
|
||
| ## Proposed Approach | ||
|
|
||
| [Briefly outline the technical steps or implementation plan required to complete this work.] | ||
|
|
||
| ## Regression Risk | ||
|
|
||
| [Identify what might accidentally break because of this change and how we will mitigate it.] | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| 1. Pipeline or automation executes successfully | ||
| 2. Existing examples and tests pass without regressions | ||
| 3. Specific internal outcome is achieved | ||
|
|
||
| ## Testing Strategy | ||
|
|
||
| [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.] |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All other templates has Activity Type. Is this intentionally left out for epics?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct. We only need it set for issues at the level below epics.