Skip to content

Commit bf41d9b

Browse files
authored
Fb update issue temp (NOAA-EMC#507)
update issue, discussion and PR templates
1 parent 46b0d18 commit bf41d9b

File tree

5 files changed

+39
-40
lines changed

5 files changed

+39
-40
lines changed

.github/ISSUE_TEMPLATE/add-development-request.md

-10
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve WW3
3+
about: Create a bug report to help us improve WW3
44
title: ''
55
labels: 'bug'
66
assignees: ''
@@ -11,7 +11,7 @@ assignees: ''
1111
A clear and concise description of what the bug is.
1212

1313
**To Reproduce**
14-
Steps to reproduce the behavior:
14+
Steps to reproduce the behavior.
1515

1616
**Expected behavior**
1717
A clear and concise description of what you expected to happen.

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Q&A about using WW3
4+
url: https://github.com/NOAA-EMC/WW3/discussions/new?category=q-a
5+
about: Ask the community for help
6+
- name: General
7+
url: https://github.com/NOAA-EMC/WW3/discussions/new?category=general
8+
about: Chat about anything and everything here
+3-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
---
2-
name: Documentation request/update
3-
about: Add new section in the documentation or report a type/mistake in the documentation
2+
name: Documentation
3+
about: Any issues in documentation including reporting a typo/mistake in the documentation or a missing section.
44
title: ''
55
labels: 'documentation'
66
assignees: ''
77

88
---
99

10-
**Describe the section in the documentation that is missing or requires an update?**
10+
<!-- Describe the section in the documentation that is missing or requires an update? -->
1111

12-
**Report a bug/typo in the documentation**
13-
14-
**Link the issue(s) associated with this documentation update**
1512

.github/pull_request_template.md

+26-22
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,45 @@
11
# Pull Request Summary
2-
(Instructions: this, and all subsequent sections of text should be removed and filled in as appropriate.)
3-
Please describe the PR summary
2+
<!-- A short overview of the PR -->
43

54
## Description
5+
<!--
66
Provide a detailed description of what this PR does.
77
What bug does it fix, or what feature does it add?
88
Is a change of answers expected from this PR?
99
10-
### Issue(s) addressed
11-
* Is there an issue associated with this development (bug fix, enhancement, new feature)?
12-
Please add a reference to a related issue(s) in WW3 repository (Follow [link](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)).
13-
Link the issues to be closed with this PR, whether in this repository, or in another repository.
14-
(Remember, issues should always be created before starting work on a PR branch!).
15-
Note that properly "linked issues" (either automatic links, or manual ones using the correct keywords) will be automatically closed when the PR is merged.
10+
Please also include the following information:
11+
* Add any suggestions for a reviewer
12+
* Mention any labels that should be added: _bug_, _documentation_, _enhancement_, _new feature_
13+
* Are answer changes expected from this PR? Please describe the changes and the reason why in addition to which of the following labels would apply: _mod_def change_, _out_grd change_, _out_pnt change_, _restart file change_, _Regression test_
14+
-->
1615

16+
### Issue(s) addressed
17+
<!--
18+
* Please list any issues associated with this PR, including those the PR will fix/close. For example:
1719
- fixes #<issue_number>
1820
- fixes noaa-emc/ww3/issues/<issue_number>
21+
-->
22+
23+
### Commit Message
24+
<!--
25+
Please provide a short summary of this PR, which will be used during _Squash and Merge_ and will be shown as a git log message. Be sure to add any co-authors here.
26+
-->
1927

2028
### Check list
21-
* Is your feature branch up to date with the authoritative repository (NOAA/develop)?
22-
* Make sure you have checked the [checklist for a developer submitting to develop](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-a-developer-submitting-to-develop) and [updating version number](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-updating-version-number)
23-
* Please list appropriate labels code managers should add for this PR:
24-
_bug_, _documentation_, _enhancement_, _new feature_, ..
25-
26-
* Reviewers: @mentions of suggested reviewers of the proposed changes
2729

28-
### Commit Message
29-
* Please provide a short summary of this PR, which will be used during _Squash and Merge_ and will be shown as git log message
30+
<!-- After creating the PR you can check each of the items below that have been completed -->
3031

32+
- [ ] Branch is up to date with the authoritative repository (NOAA-EMC) develop branch.
33+
- [ ] Checked the [checklist for a developer submitting to develop](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-a-developer-submitting-to-develop).
34+
- [ ] If a version number update is required, checked the [updating version number](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-updating-version-number) checklist.
35+
- [ ] If a new feature was added, a regression test for testing the new feature is added.
36+
3137
### Testing
38+
3239
* How were these changes tested?
3340
* Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
34-
* If a new feature was added, was a new regression test added?
35-
* Have regression tests been run?
36-
* Which compiler / HPC you used to run the regression tests in the PR?
41+
* Have the matrix regression tests been run (if yes, please note HPC and compiler)?
3742
* Please provide the summary output of matrix.comp (_matrix.Diff.txt_, _matrixCompFull.txt_ and _matrixCompSummary.txt_):
38-
Please indicate the expected changes in the outputs ([excluding the known list of non-identical tests](https://github.com/NOAA-EMC/WW3/wiki/How-to-use-matrix.comp-to-compare-regtests-with-master#4-look-at-results)).
39-
* Please list which labels code managers should add to indicate code changes:
40-
_mod_def change_, _out_grd change_, _out_pnt change_, _restart file change_, _Regression test_, ...
43+
* Please indicate the expected changes in the regression test output ([Note the known list of non-identical tests](https://github.com/NOAA-EMC/WW3/wiki/How-to-use-matrix.comp-to-compare-regtests-with-master#4-look-at-results)).
44+
* Please provide the summary output of matrix.comp (_matrix.Diff.txt_, _matrixCompFull.txt_ and _matrixCompSummary.txt_):
4145

0 commit comments

Comments
 (0)