Skip to content

Commit

Permalink
Add dependencies to PR template (#139)
Browse files Browse the repository at this point in the history
Add templates for bug and feature issues.
  • Loading branch information
JulieSchramm authored May 18, 2021
1 parent de9bd9f commit be49e65
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

# Description

Provide a clear and concise description of the bug and what behavior you are expecting.

## Steps to Reproduce

Please provide detailed steps for reproducing the issue.

1. step 1
2. step 2
3. see the bug...

## Additional Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

* Machine
* Compiler
* Reference other issues or PRs in other repositories that this is related to, and how they are related.

## Output

Please include any relevant log files, screenshots or other output here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

## Description
Provide a clear and concise description of the problem to be solved.

## Solution
Add a clear and concise description of the proposed solution.

## Alternatives (optional)
If applicable, add a description of any alternative solutions or features you've considered.

## Related to (optional)
Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related.
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ One or more paragraphs describing the problem, solution, and required changes.
## TESTS CONDUCTED:
Explicitly state what tests were run on these changes, or if any are still pending (for README or other text-only changes, just put "None required". Make note of the compilers used, the platform/machine, and other relevant details as necessary. For more complicated changes, or those resulting in scientific changes, please be explicit!

## DEPENDENCIES:
Add any links to external PRs (e.g. regional_workflow and/or UFS PRs). For example:
- NOAA-EMC/regional_workflow/pull/<pr_number>
- NOAA-EMC/UFS_UTILS/pull/<pr_number>
- ufs-community/ufs-weather-model/pull/<pr_number>

## DOCUMENTATION:
If this PR is contributing new capabilities that need to be documented, please also include updates to the RST files (docs/UsersGuide/source) as supporting material.

Expand Down

0 comments on commit be49e65

Please sign in to comment.