Skip to content

Commit

Permalink
Update issue templates to use forms and improve all templates (NOAA-E…
Browse files Browse the repository at this point in the history
…MC#1817)

* Convert issue templates into forms (PR's do not allow forms)
Resolves NOAA-EMC#1747
  • Loading branch information
WalterKolczynski-NOAA authored Aug 28, 2023
1 parent 0ab4d72 commit 11ecb20
Show file tree
Hide file tree
Showing 13 changed files with 379 additions and 277 deletions.
55 changes: 0 additions & 55 deletions .github/ISSUE_TEMPLATE/NCO_bug_report.md

This file was deleted.

66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/NCO_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: NCO Bug report
description: Report something that is incorrect or broken
labels: ["nco-bug", "triage"]
assignees:
- aerorahul

body:
- type: markdown
attributes:
value: |
Your bug may already be reported!
Please search on the [Issue tracker](https://github.com/NOAA-EMC/global-workflow/issues) before creating one.
- type: textarea
id: current_behavior
attributes:
label: What is wrong?
description: Give a brief description of what is incorrect or broken.
placeholder: |
Short log snippets that illustrate the problem can be included here.
For any longer logs, please create a GitHub gist (https://gist.github.com/) and link it here.
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: What should have happened?
placeholder: Describe what you expected to happen.
validations:
required: true

- type: textarea
id: reproduction_steps
attributes:
label: Steps to reproduce
description: Please give explicit instructions to reproduce the error
placeholder: |
1.
2.
3.
validations:
required: true

- type: input
id: bugzilla
attributes:
label: Bugzilla issue
description: What is the corresponding NCO bugzilla issue number?
placeholder: "#..."

- type: textarea
id: description
attributes:
label: Additional information
description: Provide context or any additional information about the bug.
validations:
required: true

- type: textarea
id: proposed_implementation
attributes:
label: Do you have a proposed solution?
description: If you already have an idea on how to fix this, please provide it here.
placeholder: Optional
55 changes: 0 additions & 55 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Bug report
description: Report something that is incorrect or broken
labels: ["bug", "triage"]

body:
- type: markdown
attributes:
value: |
Your bug may already be reported!
Please search on the [Issue tracker](https://github.com/NOAA-EMC/global-workflow/issues) before creating one.
- type: textarea
id: current_behavior
attributes:
label: What is wrong?
description: Give a brief description of what is incorrect or broken.
placeholder: |
Short log snippets that illustrate the problem can be included here.
For any longer logs, please create a GitHub gist (https://gist.github.com/) and link it here.
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: What should have happened?
placeholder: Describe what you expected to happen.
validations:
required: true

- type: dropdown
id: hpc
attributes:
label: What machines are impacted?
description: You may select multiple machines.
multiple: true
options:
- All or N/A
- WCOSS2
- Hera
- Orion
- Jet
- Cloud
validations:
required: true

- type: textarea
id: reproduction_steps
attributes:
label: Steps to reproduce
description: Please give explicit instructions to reproduce the error
placeholder: |
1.
2.
3.
validations:
required: true

- type: textarea
id: description
attributes:
label: Additional information
description: Provide context or any additional information about the bug.
validations:
required: true

- type: textarea
id: propsed_implementation
attributes:
label: Do you have a proposed solution?
description: If you already have an idea on how to fix this, please provide it here.
placeholder: Optional
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Feature request
description: Request new capability
labels: ["feature", "triage"]

body:
- type: markdown
attributes:
value: |
If your issue falls into one of the follow categories, please go back and use the appropriate template:
- Something is wrong or broken
- It is a request from NCO
- It is initiating a production update
- Files need to be updated or added to fix
Please search on the [Issue tracker](https://github.com/NOAA-EMC/global-workflow/issues) to make sure the feature has not already been requested to avoid duplicates.
- type: textarea
id: description
attributes:
label: What new functionality do you need?
placeholder: Provide a consise description of the problem to be addressed by this feature request. Please be clear what parts of the problem are considered to be in-scope and out-of-scope
validations:
required: true

- type: textarea
id: requirements
attributes:
label: What are the requirements for the new functionality?
validations:
required: true

- type: textarea
id: criteria
attributes:
label: Acceptance Criteria
placeholder: What does it mean for this issue to be complete?
validations:
required: true

- type: textarea
id: suggested_solution
attributes:
label: Suggest a solution (optional)
placeholder: |
Propose how this issue can be resolved.
Things to address include:
* Details of the technical implementation
* Tradeoffs made in design decisions
* Caveats and considerations for the future
If there are multiple solutions, please present each one separately. Save comparisons for the very end.)"
validations:
required: false
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/fix_file.md

This file was deleted.

Loading

0 comments on commit 11ecb20

Please sign in to comment.