Skip to content

Commit

Permalink
Refine issue and PR templates (#2947)
Browse files Browse the repository at this point in the history
Refines the issue and PR templates to cover some shortcomings and
pitfalls we have identified.

The fix file issue template is expanded to cover other data sets managed
under "glopara".

Resolves #2589
  • Loading branch information
WalterKolczynski-NOAA authored Sep 23, 2024
1 parent fe57bb4 commit ec63492
Show file tree
Hide file tree
Showing 7 changed files with 212 additions and 144 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/NCO_bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: NCO Bug report
name: NCO Bug Report
description: Report something that is incorrect or broken
labels: ["nco-bug", "triage"]
assignees:
Expand Down
14 changes: 12 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Bug report
name: Bug Report
description: Report something that is incorrect or broken
labels: ["bug", "triage"]

Expand All @@ -9,6 +9,8 @@ body:
Your bug may already be reported!
Please search on the [Issue tracker](https://github.com/NOAA-EMC/global-workflow/issues) before creating one.
Is this actually a workflow bug? If not, please open an issue in the appropriate repository first.
- type: textarea
id: current_behavior
attributes:
Expand Down Expand Up @@ -46,6 +48,13 @@ body:
validations:
required: true

- type: input
id: hash
attributes:
label: What global-workflow hash are you using?
validations:
required: true

- type: textarea
id: reproduction_steps
attributes:
Expand All @@ -63,8 +72,9 @@ body:
attributes:
label: Additional information
description: Provide context or any additional information about the bug.
placeholder: Optional
validations:
required: true
required: false

- type: textarea
id: propsed_implementation
Expand Down
17 changes: 13 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Feature request
name: Feature Request
description: Request new capability
labels: ["feature", "triage"]

Expand All @@ -10,8 +10,7 @@ body:
- 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
- Files need to be updated in a directory managed by workflow CMs under "glopara"
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.
Expand All @@ -34,7 +33,17 @@ body:
id: criteria
attributes:
label: Acceptance Criteria
placeholder: What does it mean for this issue to be complete?
description: |
A checklist of criteria to be satisfied before this feature is considered complete.
Examples:
- Forecast with option X completes successfully
- File X produced
- Output unchanged
placeholder: |
- [ ] Criterion #1
- [ ] Criterion #2
- [ ] Criterion #3
validations:
required: true

Expand Down
97 changes: 0 additions & 97 deletions .github/ISSUE_TEMPLATE/fix_file.yml

This file was deleted.

29 changes: 15 additions & 14 deletions .github/ISSUE_TEMPLATE/production_update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,19 @@ body:
validations:
required: true

- type: markdown
- type: checkboxes
attributes:
value: |
** Tasks **
- [ ] Create release branch
- [ ] Make workflow changes for upgrade in release branch (add additional checklist items as needed)
- [ ] Create release notes
- [ ] Cut hand-off tag for CDF
- [ ] Submit CDF to NCO
- [ ] Implementation into operations complete
- [ ] Merge release branch into operational branch
- [ ] Cut version tag from operational branch
- [ ] Release new version tag
- [ ] Announce to users
- [ ] Update Read-The-Docs operations status version in develop
label: Tasks
description: List of tasks to complete update. For use after issue is created.
options:
- label: Create release branch
- label: Make workflow changes for upgrade in release branch (add additional checklist items as needed)
- label: Create release notes
- label: Cut hand-off tag for CDF
- label: Submit CDF to NCO
- label: Implementation into operations complete
- label: Merge release branch into operational branch
- label: Cut version tag from operational branch
- label: Release new version tag
- label: Announce to users
- label: Update Read-The-Docs operations status version in develop
134 changes: 134 additions & 0 deletions .github/ISSUE_TEMPLATE/static_data.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
name: Static Data Update
description: Request static data be added or updated
labels: ["Static Data Mgmt"]
assignees:
- KateFriedman-NOAA
- WalterKolczynski-NOAA

body:
- type: dropdown
attributes:
label: Type of static data
description: |
- Fix: large static files needed to run global-workflow
- Initial conditions: ICs needed to run one of global-workflow's included tests
- Experimental data: Temporary datasets needed for development that will be replaced by other sources for operations (e.g. data that will be in DCOM)
options:
- Fix
- Initial conditions
- Experimental data
validations:
required: true

- type: dropdown
attributes:
label: Target directory
options:
- "Fix: aer"
- "Fix: am"
- "Fix: chem"
- "Fix: cice"
- "Fix: cpl"
- "Fix: datm"
- "Fix: gdas/crtm"
- "Fix: gdas/fv3jedi"
- "Fix: gdas/gsibec"
- "Fix: gldas"
- "Fix: glwu"
- "Fix: gsi"
- "Fix: lut"
- "Fix: mom6"
- "Fix: orog"
- "Fix: raw"
- "Fix: reg2grb2"
- "Fix: sfc_climo"
- "Fix: ugwd"
- "Fix: verif"
- "Fix: wave"
- "Fix: *NEW*"
- "ICs: C48/C48 mx500"
- "ICs: C96/C48"
- "ICs: C96 mx100"
- "ICs: C384/C192"
- "ICs: C384 mx025"
- "ICs: C768 mx025"
- "ICs: C1152 mx025"
- "ICs: *NEW RESOLUTION*"
- "Exp Data: GOCART emissions"
- "Exp Data: JEDI obs"
- "Exp Data: *NEW*"
multiple: true
validations:
required: true

- type: checkboxes
attributes:
label: Type of change
options:
- label: Update existing files (Version update needed)
- label: Remove files (Version update needed)
- label: Add new files to existing directory
- label: Add new directory (Version update needed if fix)
validations:
required: true

- type: dropdown
attributes:
label: Any workflow changes needed?
description: |
ANY fix or IC change other than adding files will require at least a new version.
options:
- No change needed
- Fix/IC version update only
- Fix/IC version update + additional changes
- Non-version changes only
validations:
required: true

- type: textarea
attributes:
label: |
Please list all related issues. If this request requires a workflow update (including a fix version update), please open a *separate* global-workflow issue to track the change.
description: Please link any related issues
placeholder: NOAA-EMC/repo#1234
validations:
required: false

- type: input
attributes:
label: Pickup location
description: |
Please provide a path to the data on either Hera or WCOSS.
If this requires a version update, please provide a CLEAN copy of the *entire* directory, including the structure and unchanged files from current directory.
If this is just adding additional files, you may provide just the new files. The directory structure should still match the target.
placeholder: '/path/to/new/data'
validations:
required: true

- type: input
attributes:
label: Size
description: How much data needs to be copied (size of pickup location in MB)?
placeholder: '0'
validations:
required: true

- type: textarea
attributes:
label: Additional information
description: |
Please provide any additional information needed for this request. If this is a new directory, please provide a short description and a point of contact.
validations:
required: false

- type: markdown
attributes:
value: |
# Tasks
- [ ] Discuss needs with global-workflow developer assigned to request
- [ ] Stage a CLEAN copy of data on Hera or WCOSS in the location provided above
- [ ] [global-workflow CM] Update data in "glopara"-managed space on supported platforms
- [ ] [Fix only] Update "Fix File Management" [spreadsheet](https://docs.google.com/spreadsheets/d/1BeIvcz6TO3If4YCqkUK-oz_kGS9q2wTjwLS-BBemSEY/edit?usp=sharing)
- [ ] Make related workflow/component updates (if any)
Loading

0 comments on commit ec63492

Please sign in to comment.