Skip to content

Commit

Permalink
Issue and PR templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
henrywinterbottom-wxdev committed Oct 29, 2023
1 parent 7c2e3bd commit 6cdab5c
Show file tree
Hide file tree
Showing 3 changed files with 128 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Software Bug Report
description: >
Raise an issue for something that is either a software bug or a
feature that is broken.
labels:
- bug
body:
- type: markdown
attributes:
value: >
Please search the open issues
[here](https://github.com/HenryWinterbottom-NOAA/ufs_tools/issues)
before creating new one.
- type: dropdown
id: platforms
attributes:
label: Please indicate any/all platforms that are impacted.
multiple: true
options:
- RDHPCS Hera
- RDHPCS Orion
- RDHPCS Jet
- NOAA CSP AWS
- Other
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected behavior.
description: |
Please described the expected outcome if the respective issue
and/or bug were not present.
validations:
required: true
- type: textarea
id: actual_behavior
attributes:
label: Actual behavior.
description: >
Please described the behavior to be encountered by the current
issue and/or bug.
validations:
required: true
- type: textarea
id: additional_info
attributes:
label: Additional information.
description: |
Please provide any supplementary information to aid the developer(s).
validations:
required: false
50 changes: 50 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Software Feature Request
description: >
Request a feature and/or enhancement for the respective software
package.
labels:
- enhancement
body:
- type: markdown
attributes:
value: >
Please search the open issues
[here](https://github.com/HenryWinterbottom-NOAA/ufs_tools/issues)
before creating new one.
- type: textarea
id: motivation
attributes:
label: Motivation.
description: |
Please explain the benefits of the feature and/or enhancement
being requested.
validations:
required: true
- type: textarea
id: proposed_solution
attributes:
label: Proposed solution.
description: |
Please provide a enumerated list of steps to resolve the new
feature and/or enhancement being requested.
validations:
required: true
- type: textarea
id: additional_context
attributes:
label: Additional context.
description: |
Please include any additional information and/or context
relevant to the feature request.
validations:
required: false
- type: textarea
id: related_issues
attributes:
label: Related issues.
description: |
Please link any related issues.
validations:
required: false

25 changes: 25 additions & 0 deletions .github/workflows/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## Pull Request

**Description**

Please provide a clear and concise description of the changes in this
pull request.

**Related Issues**

- Closes #XXX
- Fixes #YYY

# Checklist

- [ ] Any dependent changes have been merged and published.
- [ ] Any new coding follows the style guidelines of this project and have been commented and reviewed prior to pull-request.
- [ ] New coding does not cause new warnings.
- [ ] All current unit-tests pass with new changes.
- [ ] Any new documentation required of the pull-request have been included.

**Additional Information**

- Please provide any additional information or context for the
developer(s).

0 comments on commit 6cdab5c

Please sign in to comment.