-
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
Changes from 2 commits
6cacb1f
6a17ff8
75d9daf
b2287d0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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.] |
| 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. | ||
| 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 | ||
|
|
||
| [Check the expected outputs of this investigation.] | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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.."
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The checkboxes don't look to be standard Markdown in Jira, but in ADF. I'll change the instructions. |
||
|
|
||
| 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 | ||
| 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.] |
| 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.] |
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.