-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New GitHub Issue template for Work Item Creation (#587)
New GitHub Issue template to support Work Item Creation. --------- Co-authored-by: Shawn Alpay <[email protected]> Co-authored-by: Christopher Harris <[email protected]>
- Loading branch information
3 people
authored
Oct 17, 2024
1 parent
4781ae0
commit c7abe9c
Showing
2 changed files
with
174 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,53 @@ | ||
| # Work Item Issue Template | ||
| description: | ||
| title: "[Work_Item]" | ||
| labels: ["work item"] | ||
| assignees: [shawnalpay, jpradocueva] | ||
|
|
||
| ### **Template Usage Notes**: | ||
| 1. All fields marked as **mandatory** [*] must be filled before submission. While some datapoints are optional for the initial creation of the work item, all datapoints must be provided in order to be considered for spec development. | ||
| 2. If you have suggestions for the specification but cannot fill out all fields in this issue template, please fill out a [Feedback] or [Discussion] issue template instead. | ||
| 3. For **Supporting Documentation**, ensure that linked files are accessible to relevant stakeholders. | ||
|
|
||
| --- | ||
|
|
||
| ## 1. **Problem Statement** * | ||
| Describe the problem, issue, use case, or opportunity that this work item addresses. | ||
| Include practitioner quotes illustrating real examples a) of questions being asked by practitioners and b) value unlocked by answering these questions, if available. | ||
| - **What is the problem?**: Explain the context and why it needs resolution. | ||
| - **Impact**: Describe how the problem affects users, systems, or the project. | ||
|
|
||
| Your input ... | ||
|
|
||
| ## 2. **Objective** * | ||
| State the objective of this work item. What outcome is expected? | ||
| - **Success Criteria**: Define how success will be measured (e.g. metrics and KPIs). | ||
|
|
||
| Your input ... | ||
|
|
||
| ## 3. **Supporting Documentation** * | ||
| Include links to supporting documents such as: | ||
| - Data Examples: [Link to data or relevant files; DO NOT share proprietary information] | ||
| - Related Use Cases or Discussion Documents: [Link to discussion] | ||
| - PRs or Other References: [Link to relevant references] | ||
|
|
||
| Your input ... | ||
|
|
||
| ## 4. **Proposed Solution / Approach** | ||
| Outline any proposed solutions, approaches, or potential paths forward. Do not submit detailed solutions; please keep suggestions high-level. | ||
| - **Initial Ideas**: Describe potential solution paths, tools, or technologies. | ||
| - **Considerations**: Include any constraints, dependencies, or risks. | ||
| - **Feasibility**: Include any information that helps quantify feasibility, such as perceived level of effort to augment the spec, or existing fields in current data generator exports. | ||
| - **Benchmarks**: Are there established best practices for solving this problem available to practitioners today (e.g. mappings from existing CSP exports that are widely used)? | ||
|
|
||
| Your input ... | ||
|
|
||
| ## 5. **Epic or Theme Association** | ||
| > This section will be completed by the Maintainers. | ||
| > - **Epic**: [Epic Name] | ||
| > - **Theme**: [Theme Name, if applicable] | ||
| ## 6. **Stakeholders** * | ||
| List the main stakeholders for this issue. | ||
| - **Primary Stakeholders**: [Name/Role] | ||
| - **Other Involved Parties**: [Names/Roles] |
This file contains 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,121 @@ | ||
| name: "Work Item Issue Template" | ||
| description: "Template for creating new work item issues" | ||
| title: "[Work_Item]" | ||
| labels: | ||
| - "work item" | ||
| assignees: | ||
| - "shawnalpay" | ||
| - "jpradocueva" | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
| ### **Template Usage Notes**: | ||
| 1. All fields marked as **mandatory** [*] must be filled before submission. While some datapoints are optional for the initial creation of the work item, all datapoints must be provided in order to be considered for spec development. | ||
| 2. If you have suggestions for the specification but cannot fill out all fields in this issue template, please fill out a [Feedback] or [Discussion] issue template instead. | ||
| 3. For **Supporting Documentation**, ensure that linked files are accessible to relevant stakeholders. | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## 1. **Problem Statement** | ||
| Describe the problem, issue, use case, or opportunity that this work item addresses. | ||
| Include practitioner quotes illustrating real examples a) of questions being asked by practitioners and b) value unlocked by answering these questions, if available. | ||
| - **What is the problem?**: Explain the context and why it needs resolution. | ||
| - **Impact**: Describe how the problem affects users, systems, or the project. | ||
| - type: textarea | ||
| id: problem_statement | ||
| attributes: | ||
| label: "Problem Statement" | ||
| description: "Provide a detailed explanation of the problem or issue." | ||
| placeholder: "Your input here..." | ||
| value: "Provide details of the problem statement here." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## 2. **Objective** | ||
| State the objective of this work item. What outcome is expected? | ||
| - **Success Criteria**: Define how success will be measured (e.g. metrics and KPIs). | ||
| - type: textarea | ||
| id: objective | ||
| attributes: | ||
| label: "Objective" | ||
| description: "Describe the expected outcome and success criteria." | ||
| placeholder: "Your input here..." | ||
| value: "Outline the expected outcome and success criteria." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## 3. **Supporting Documentation** | ||
| - Data Examples: [Link to data or relevant files; DO NOT share proprietary information] | ||
| - Related Use Cases or Discussion Documents: [Link to discussion] | ||
| - PRs or Other References: [Link to relevant references] | ||
| - type: textarea | ||
| id: supporting_documentation | ||
| attributes: | ||
| label: "Supporting Documentation" | ||
| description: "Provide links to data examples, use cases, PRs, or other relevant documents." | ||
| placeholder: "Your input here..." | ||
| value: "Include links to supporting documentation, if applicable." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## 4. **Proposed Solution / Approach** | ||
| Outline any proposed solutions, approaches, or potential paths forward. Do not submit detailed solutions; please keep suggestions high-level. | ||
| - **Initial Ideas**: Describe potential solution paths, tools, or technologies. | ||
| - **Considerations**: Include any constraints, dependencies, or risks. | ||
| - **Feasibility**: Include any information that helps quantify feasibility, such as perceived level of effort to augment the spec, or existing fields in current data generator exports. | ||
| - **Benchmarks**: Are there established best practices for solving this problem available to practitioners today (e.g. mappings from existing CSP exports that are widely used)? | ||
| - type: textarea | ||
| id: proposed_solution | ||
| attributes: | ||
| label: "Proposed Solution / Approach" | ||
| description: "Outline potential solutions or approaches." | ||
| placeholder: "Your input here..." | ||
| value: "Summarize the proposed solution or approach." | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## 5. **Epic or Theme Association** | ||
| > This section will be completed by the Maintainers. | ||
| > - **Epic**: [Epic Name] | ||
| > - **Theme**: [Theme Name, if applicable] | ||
| - type: textarea | ||
| id: epic_theme | ||
| attributes: | ||
| label: "Epic or Theme Association" | ||
| description: "Provide potential epics or themes" | ||
| placeholder: "Your input here..." | ||
| value: "Provide the rational for the Epic or Theme." | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## 6. **Stakeholders** | ||
| List the main stakeholders for this issue. | ||
| - **Primary Stakeholder**: [Name/Role] | ||
| - **Other Involved Parties**: [Names/Roles] | ||
| - type: textarea | ||
| id: stakeholders | ||
| attributes: | ||
| label: "Stakeholders" | ||
| description: "List the main stakeholders for this work item." | ||
| placeholder: "Your input here..." | ||
| value: "Provide names and roles of key stakeholders." |