Skip to content

Commit c6bcb7a

Browse files
authored
Update GitHub issue/pull request templates, update project charter and documentation (installers, sites) (#1692)
* Update GitHub issue and PR templates * Update code managers in project_charter.md * Update doc/source/PreConfiguredSites.rst
1 parent d8e994d commit c6bcb7a

File tree

6 files changed

+48
-32
lines changed

6 files changed

+48
-32
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,22 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
## Description
1211

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
12+
_A clear and concise description of what the bug is._
1513

16-
**Expected behavior**
17-
A clear and concise description of what you expected to happen.
14+
## To Reproduce
1815

19-
**System:**
20-
What system(s) are you running the code on?
16+
_Steps to reproduce the behavior._
2117

22-
**Additional context**
23-
Add any other context about the problem here.
18+
## Expected behavior
19+
20+
_A clear and concise description of what you expected to happen._
21+
22+
## System, compiler, code, ...
23+
24+
_What system(s) are you running the code on? Which compiler? Which version of the code? Any other details you can provide?_
25+
26+
## Additional context
27+
28+
_Add any other context about the problem here._

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,14 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
## Is your feature request related to a problem?
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
_A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
1513

16-
**Additional context**
17-
Add any other context or screenshots about the feature request here.
14+
## Describe the solution you'd like
15+
16+
_A clear and concise description of what you want to happen._
17+
18+
## Additional context
19+
20+
_Add any other context or screenshots about the feature request here._

.github/ISSUE_TEMPLATE/install_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: "Install/upgrade request"
22
description: Request an installation or upgrade of a package on HPCs
33
title: "[INSTALL]: "
44
labels: [install]
5-
assignees: [Hang-Lei-NOAA, AlexanderRichert-NOAA, jkbk2004, climbfuji]
5+
assignees: []
66

77
body:
88
- type: markdown

.github/pull_request_template.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
### Summary
1+
## Description
22

3-
Describe the changes made in this PR and why they are needed.
3+
_Note. The title and description will be used as commit log title and message for squash merges._
44

5-
### Testing
5+
## Dependencies
66

7-
Describe the testing done for this PR.
7+
_If there are PRs that need to be merged before or along with this one, please add "- [ ] waiting on LINK_TO_PR" for each of them._
8+
9+
## Issues addressed
10+
11+
_Add any issues here that this PR closes or is related to. Use "Resolves" or "Closes" to automatically close issues when the PR is merged. Using "Working towards" or "Related to" for other cases._
812

913
### Applications affected
1014

@@ -14,15 +18,19 @@ List all known applications (UFS WM, JEDI, SRW, etc.) intentionally or unintenti
1418

1519
List all systems intentionally or unintentionally affected by this PR.
1620

17-
### Dependencies
18-
19-
If there are PRs that need to be merged before or along with this one, please add "- [ ] waiting on LINK_TO_PR" for each of them
21+
## Testing
2022

21-
### Issue(s) addressed
23+
- CI: _Note whether the automatic tests (GitHub actions tests that run automatically for every commit) pass or not_
24+
- [ ] GitHub actions CI tests pass
25+
- [ ] GitHub actions CI tests do not pass (_provide explanation_)
26+
- [ ] GitHub actions CI tests skipped (_provide explanation if necessary_)
27+
- New tests added: _List and describe any new tests added to GitHub actions_
28+
- [ ] ...
29+
- Additional testing: _Add information on any additional tests conducted_
30+
- [ ] ...
2231

23-
Link the issues addressed or resolved by this PR (use `Fixes #???` for fully resolved issues)
32+
## Checklist
2433

25-
### Checklist
26-
- [ ] This PR addresses one issue/problem/enhancement, or has a very good reason for not doing so.
34+
- [ ] This PR addresses one issue/problem/enhancement or has a very good reason for not doing so.
2735
- [ ] These changes have been tested on the affected systems and applications.
2836
- [ ] All dependency PRs/issues have been resolved and this PR can be merged.

doc/source/PreConfiguredSites.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Pre-configured sites (tier 1)
7272
| +-----------------------+--------------------+--------------------------------------------------------+-----------------+
7373
| | Blueback | GCC, oneAPI | ``/p/app/projects/NEPTUNE/spack-stack/`` | NRL |
7474
+---------------------+-----------------------+--------------------+--------------------------------------------------------+-----------------+
75-
| Univ. of Wisconsin | S4 | Intel | ``/data/prod/jedi/spack-stack/`` | SSEC |
75+
| Univ. of Wisconsin | S4 | Intel | ``/data/prod/jedi/spack-stack/`` | TBD |
7676
+---------------------+-----------------------+--------------------+--------------------------------------------------------+-----------------+
7777
| **Cloud platforms** |
7878
+---------------------+-----------------------+--------------------+--------------------------------------------------------+-----------------+

project_charter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ spack-stack repo.
3333

3434
Organization | Code Manager(s)
3535
-------------|----------------
36-
NOAA EMC | Alex Richert, Hang Lei, Ed Hartnett
37-
JCSDA | Steve Herbener, TBD
38-
EPIC | Cam Book, Natalie Perlin, Ratko Vasic
36+
NOAA EMC | Alex Richert, Hang Lei
37+
JCSDA | Steve Grace, Evan Parker
38+
EPIC | Rick Grubin, Ratko Vasic
3939
NRL | Dom Heinzeller, Sarah King
4040

4141
## Project Process

0 commit comments

Comments
 (0)