Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanpadams committed Aug 22, 2024
1 parent 044a4b6 commit 3705c48
Show file tree
Hide file tree
Showing 5 changed files with 180 additions and 58 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Bug report
description: Report a bug to help us improve
title: <system feature> <is not/does not> <expected behaviour>
labels: "bug,needs:triage"
assignees: jordanpadams

body:
- type: dropdown
id: checked-for-duplicates
attributes:
label: Checked for duplicates
description: Have you checked for duplicate issue tickets?
multiple: false
options:
- "Yes - I've already checked"
- "No - I haven't checked"
validations:
required: yes
- type: textarea
id: description
attributes:
label: 🐛 Describe the bug
description: A clear and concise description of what the bug is. Plain-text snippets and/or screenshots welcome.
placeholder: Tell us what you saw
value: "When I did [...] action, I noticed [...]"
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: 🕵️ Expected behavior
description: A clear and concise description of what you expected to happen
placeholder: Tell us what you expected
value: "I expected [...]"
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: 📜 To Reproduce
description: "How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets and/or screenshots welcome."
value: |
1.
2.
3.
...
render: bash

- type: textarea
id: environment
attributes:
label: 🖥 Environment Info
description: "What is your environment? Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue"
value: |
- Version of this software [e.g. vX.Y.Z]
- Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
...
render: bash

- type: textarea
id: version
attributes:
label: 📚 Version of Software Used
description: Command-line tools should have a `-V` or `--version` flag to get this information.

- type: textarea
id: test_data
attributes:
label: 🩺 Test Data / Additional context
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."

- type: textarea
id: requirements
attributes:
label: 🦄 Related requirements
description: If known, provide links to the requirements/user stories applicable to this bug.
value: "🦄 #xyz"

- type: markdown
attributes:
value: |
## For Internal Dev Team To Complete
- type: textarea
id: details
attributes:
label: ⚙️ Engineering Details
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: Feature request
description: Suggest a new idea or new requirement for this project
title: As a <what is the user's role?>, I want to <what is the user trying to accomplish?>
labels: "needs:triage,requirement"
assignees: jordanpadams

body:
- type: markdown
attributes:
value: |
> _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_
- type: dropdown
id: checked-for-duplicates
attributes:
label: Checked for duplicates
description: Have you checked for duplicate issue tickets?
multiple: false
options:
- "Yes - I've already checked"
- "No - I haven't checked"
validations:
required: yes

- type: textarea
id: personas
attributes:
label: 🧑‍🔬 User Persona(s)
description: What specific types of users to you think this feature applies to?
placeholder: Node Operator, Data Engineer, Data User, etc.
validations:
required: false

- type: textarea
id: motivation
attributes:
label: 💪 Motivation
description: Why? Finish the user story in the title.
value: "...so that I can [why do you want to do this?]"
validations:
required: false

- type: textarea
id: details
attributes:
label: 📖 Additional Details
description: Provide any additional details, related problems, or information that could help provide some context for the user story.
validations:
required: false

- type: markdown
attributes:
value: |
## For Internal Dev Team To Complete
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: To be filled out by Engineering Node Team
value: |
**Given** <!-- a condition -->
**When I perform** <!-- an action -->
**Then I expect** <!-- the result -->
validations:
required: false

- type: textarea
id: engineering-details
attributes:
label: ⚙️ Engineering Details
description: To be filled out by Engineering Node Team
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.
validations:
required: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Task
about: Low level task or action that is often too granular for testing, but helps
towards progress on an Epic or parent story
title: ''
labels: B13.1, i&t.skip, task
assignees: ''

---

<!--
For more information on how to populate this Task, see the PDS Wiki on User Story Development:
https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Issue-Tracking#user-story-development
-->

## 💡 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 -->

0 comments on commit 3705c48

Please sign in to comment.