Skip to content

Commit 092b41d

Browse files
jordanpadamsjordanpadams
authored
Merge pull request #93 from NASA-PDS/add_issue_templates
Add Issue Template examples to template repo
2 parents 3bb47ee + 6077fd4 commit 092b41d

5 files changed

Lines changed: 308 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE_example/-bug_report.yml.template‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Bug report
2+
description: Report a bug to help us improve
3+
title: <system feature> <is not/does not> <expected behaviour>
4+
labels: "bug,needs:triage"
5+
type: "Bug"
6+
7+
body:
8+
- type: dropdown
9+
id: checked-for-duplicates
10+
attributes:
11+
label: Checked for duplicates
12+
description: Have you checked for duplicate issue tickets?
13+
multiple: false
14+
options:
15+
- "No - I haven't checked"
16+
- "Yes - I've already checked"
17+
validations:
18+
required: yes
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: 🐛 Describe the bug
23+
description: A clear and concise description of what the bug is. Plain-text snippets and/or screenshots welcome.
24+
placeholder: Tell us what you saw
25+
value: "When I did [...] action, I noticed [...]"
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: expected-behavior
31+
attributes:
32+
label: 🕵️ Expected behavior
33+
description: A clear and concise description of what you expected to happen
34+
placeholder: Tell us what you expected
35+
value: "I expected [...]"
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: reproduction
41+
attributes:
42+
label: 📜 To Reproduce
43+
description: "How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets and/or screenshots welcome."
44+
value: |
45+
1.
46+
2.
47+
3.
48+
...
49+
50+
- type: textarea
51+
id: environment
52+
attributes:
53+
label: 🖥 Environment Info
54+
description: "What is your environment? Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue"
55+
value: |
56+
- Version of this software [e.g. vX.Y.Z]
57+
- Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
58+
...
59+
60+
- type: textarea
61+
id: version
62+
attributes:
63+
label: 📚 Version of Software Used
64+
description: Command-line tools should have a `-V` or `--version` flag to get this information.
65+
66+
- type: textarea
67+
id: test_data
68+
attributes:
69+
label: 🩺 Test Data / Additional context
70+
description: "If not provided already, upload some test data. Note: May need to create a ZIP/TAR if the files are not compatible with GitHub."
71+
72+
- type: textarea
73+
id: requirements
74+
attributes:
75+
label: 🦄 Related requirements
76+
description: If known, provide links to the requirements/user stories applicable to this bug.
77+
value: "🦄 #xyz"
78+
79+
- type: markdown
80+
attributes:
81+
value: |
82+
## For Internal Dev Team To Complete
83+
84+
- type: textarea
85+
id: details
86+
attributes:
87+
label: ⚙️ Engineering Details
88+
89+
- type: textarea
90+
id: i-n-t
91+
attributes:
92+
label: 🎉 Integration & Test
93+
description: To be filled out by Engineering Node Team
94+
placeholder: Provide testing information and/or trace to TestRail ID
95+
validations:
96+
required: false

‎.github/ISSUE_TEMPLATE_example/-feature_request.yml.template‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Feature request
2+
description: Suggest a new idea or new requirement for this project
3+
title: As a <what is the user's role?>, I want to <what is the user trying to accomplish?>
4+
labels: "needs:triage,requirement"
5+
type: "Feature"
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
> _Thanks for filing a new feature request. We appreciate your time and effort. Please answer a few questions. For more information on how to populate this new feature request, see the PDS Wiki on User Story Development: https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Issue-Tracking#user-story-development_
12+
- type: dropdown
13+
id: checked-for-duplicates
14+
attributes:
15+
label: Checked for duplicates
16+
description: Have you checked for duplicate issue tickets?
17+
multiple: false
18+
options:
19+
- "No - I haven't checked"
20+
- "Yes - I've already checked"
21+
validations:
22+
required: yes
23+
24+
- type: textarea
25+
id: personas
26+
attributes:
27+
label: 🧑‍🔬 User Persona(s)
28+
description: What specific types of users to you think this feature applies to?
29+
placeholder: Node Operator, Data Engineer, Data User, etc.
30+
validations:
31+
required: false
32+
33+
- type: textarea
34+
id: motivation
35+
attributes:
36+
label: 💪 Motivation
37+
description: Why? Finish the user story in the title.
38+
value: "...so that I can [why do you want to do this?]"
39+
validations:
40+
required: false
41+
42+
- type: textarea
43+
id: details
44+
attributes:
45+
label: 📖 Additional Details
46+
description: Provide any additional details, related problems, or information that could help provide some context for the user story.
47+
validations:
48+
required: false
49+
50+
- type: markdown
51+
attributes:
52+
value: |
53+
## For Internal Dev Team To Complete
54+
55+
- type: textarea
56+
id: acceptance-criteria
57+
attributes:
58+
label: Acceptance Criteria
59+
description: To be filled out by Engineering Node Team
60+
value: |
61+
**Given** <!-- a condition -->
62+
**When I perform** <!-- an action -->
63+
**Then I expect** <!-- the result -->
64+
validations:
65+
required: false
66+
67+
- type: textarea
68+
id: engineering-details
69+
attributes:
70+
label: ⚙️ Engineering Details
71+
description: To be filled out by Engineering Node Team
72+
placeholder: Provide some design / implementation details and/or a sub-task checklist as needed. Convert issue to Epic if estimate is outside the scope of 1 sprint.
73+
validations:
74+
required: false
75+
76+
- type: textarea
77+
id: i-n-t
78+
attributes:
79+
label: 🎉 I&T
80+
description: To be filled out by Engineering Node Team
81+
placeholder: Provide testing information and/or trace to TestRail ID
82+
validations:
83+
required: false

‎.github/ISSUE_TEMPLATE_example/-vulnerability-issue.yml.template‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Vulnerability Issue
2+
description: Describe security vulnerability
3+
title: "[SECURITY] <system feature> <is not/does not> <expected behaviour>"
4+
labels: "bug,needs:triage"
5+
type: "Bug"
6+
projects: "NASA-PDS/6"
7+
assignees: jordanpadams
8+
9+
body:
10+
- type: dropdown
11+
id: checked-for-duplicates
12+
attributes:
13+
label: Checked for duplicates
14+
description: Have you checked for duplicate issue tickets?
15+
multiple: false
16+
options:
17+
- "Yes - I've already checked"
18+
- "No - I haven't checked"
19+
validations:
20+
required: yes
21+
- type: textarea
22+
id: description
23+
attributes:
24+
label: 🐛 Describe the vulnerability
25+
description: Describe the vulnerability or link to the Code scanning / Dependabot issues
26+
placeholder: Tell us what you saw
27+
value: "When I did [...] action, I noticed [...]"
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: expected-behavior
33+
attributes:
34+
label: 🕵️ Expected behavior
35+
description: A clear and concise description of what you expected to happen
36+
placeholder: Tell us what you expected
37+
value: "I expected [...]"
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: reproduction
43+
attributes:
44+
label: 📜 To Reproduce
45+
description: "How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets and/or screenshots welcome."
46+
value: |
47+
1.
48+
2.
49+
3.
50+
...
51+
render: bash
52+
53+
- type: textarea
54+
id: environment
55+
attributes:
56+
label: 🖥 Environment Info
57+
description: "What is your environment? Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue"
58+
value: |
59+
- Version of this software [e.g. vX.Y.Z]
60+
- Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
61+
...
62+
render: bash
63+
64+
- type: textarea
65+
id: version
66+
attributes:
67+
label: 📚 Version of Software Used
68+
description: Command-line tools should have a `-V` or `--version` flag to get this information.
69+
70+
- type: textarea
71+
id: test_data
72+
attributes:
73+
label: 🩺 Test Data / Additional context
74+
description: "If not provided already, upload some test data. Note: May need to create a ZIP/TAR if the files are not compatible with GitHub."
75+
76+
- type: textarea
77+
id: requirements
78+
attributes:
79+
label: 🦄 Related requirements
80+
description: If known, provide links to the requirements/user stories applicable to this bug.
81+
value: "🦄 #xyz"
82+
83+
- type: markdown
84+
attributes:
85+
value: |
86+
## For Internal Dev Team To Complete
87+
88+
- type: textarea
89+
id: details
90+
attributes:
91+
label: ⚙️ Engineering Details

‎.github/ISSUE_TEMPLATE_example/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: PDS Help Desk
4+
url: mailto:pds-operator@jpl.nasa.gov
5+
about: Contact the PDS Help Desk with any additional questions you may have.

‎.github/ISSUE_TEMPLATE_example/task.yml.template‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "[internal] Task"
2+
description: "Low level task or action that is often too granular for testing, but helps towards progress on an Epic or parent story"
3+
labels: "task"
4+
type: "Task"
5+
6+
body:
7+
- type: dropdown
8+
id: check
9+
attributes:
10+
label: Are you sure this is not a new requirement or bug?
11+
options:
12+
- "No"
13+
- "Yes"
14+
validations:
15+
required: true
16+
- type: dropdown
17+
id: task-type
18+
attributes:
19+
label: Task Type
20+
description: If sub-task, be sure to select Epic (Parent issue in GitHub) from right panel after creation (Relationships -> Add Parent). If release theme, be sure to update label to be `theme` instead of `task`.
21+
options:
22+
- Sub-task
23+
- Theme
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: 💡 Description
30+
description: Enter description here. Make it detailed enough someone could actually know what you are doing, but if you spend too much time on this, it probably deserves it's own story.
31+
placeholder: Tell us what is up
32+
validations:
33+
required: true

0 commit comments

Comments
 (0)