Skip to content

Commit a4e76d8

Browse files
authored
Merge pull request #156 from billsacks/issue_types
Updates the issue and PR templates. A major change is adding a bunch of links to other places where people should consider going for help or opening issues. To see how this looks, go here: https://github.com/billsacks/cesm/issues/new/choose. My original plan was to just add a link to the CESM forums, but then I thought it could be useful to add links to open issues for any of the CESM externals. I'm not sure, though: Is this helpful or too much?
2 parents 0a46858 + edc64eb commit a4e76d8

File tree

5 files changed

+84
-16
lines changed

5 files changed

+84
-16
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 6 deletions
This file was deleted.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report, CESM-wide or unknown component
3+
about: Report a problem with CESM for an unknown component; in many cases, one of the links below is more appropriate
4+
5+
---
6+
7+
### Brief summary of bug
8+
9+
[Give a one or two sentence summary. This could be the same as the issue title if you feel that is a sufficient summary.]
10+
11+
### General bug information
12+
13+
**CESM version you are using:** [Output of `git describe`]
14+
15+
**Machine you are using:** [Fill this in]
16+
17+
**Have you modified the code? (If so, please point us to you changes.):** [Yes / No]
18+
19+
### Details of bug
20+
21+
[Fill in details here.]
22+
23+
### Steps to reproduce the problem. Include externals description file(s) and link to public repository
24+
25+
[Fill this in with anything relevant that you haven't already noted; if there is nothing to add, delete this section.]
26+
27+
### Screen output or log file showing the error message and context
28+
29+
[Fill this in with anything relevant that you haven't already noted; if there is nothing to add, delete this section.]
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Enhancement request, CESM-wide or unknown component
3+
about: Suggest a CESM-wide enhancement; in many cases, one of the links below is more appropriate
4+
5+
---
6+
7+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: CESM forums
4+
url: https://bb.cgd.ucar.edu/cesm/
5+
about: For support with model use, troubleshooting, etc., please use the CESM forums
6+
- name: CIME issue
7+
url: https://github.com/ESMCI/cime/issues/new/choose
8+
about: Issue with CIME (scripting infrastructure, share code, etc.)
9+
- name: CAM issue
10+
url: https://bb.cgd.ucar.edu/cesm/forums/cam.133/
11+
about: Issue with CAM (Community Atmosphere Model) - please report via forums
12+
- name: CTSM / CLM issue
13+
url: https://github.com/ESCOMP/CTSM/issues/new/choose
14+
about: Issue with CTSM / CLM (Community Terrestrial Systems Model / Community Land Model)
15+
- name: POP issue
16+
url: https://github.com/ESCOMP/POP2-CESM/issues/new/choose
17+
about: Issue with POP in CESM (Parallel Ocean Program)
18+
- name: MOM issue
19+
url: https://github.com/ESCOMP/MOM_interface/issues/new/choose
20+
about: Issue with MOM in CESM (Modular Ocean Model)
21+
- name: CICE5 issue
22+
url: https://github.com/ESCOMP/CESM_CICE5/issues/new/choose
23+
about: Issue with CICE5
24+
- name: CISM issue
25+
url: https://github.com/ESCOMP/cism-wrapper/issues/new/choose
26+
about: Issue with CISM (Community Ice Sheet Model)
27+
- name: MOSART issue
28+
url: https://github.com/ESCOMP/MOSART/issues/new/choose
29+
about: Issue with MOSART in CESM (Model for Scale Adaptive River Transport)
30+
- name: RTM issue
31+
url: https://github.com/ESCOMP/RTM/issues/new/choose
32+
about: Issue with RTM (River Transport Model)
33+
- name: WW3 issue
34+
url: https://github.com/ESCOMP/WW3-CESM/issues/new/choose
35+
about: Issue with WW3 in CESM (WaveWatch III)
36+
- name: CMEPS issue
37+
url: https://github.com/ESCOMP/CMEPS/issues/new/choose
38+
about: Issue with CMEPS (NUOPC Community Mediator for Earth Prediction Systems )
39+
- name: FMS issue
40+
url: https://github.com/ESCOMP/FMS_interface/issues/new/choose
41+
about: Issue with FMS in CESM

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1-
[ 50 character, one line summary ]
1+
### Description of changes
22

3-
[ Description of the changes in this commit. It should be enough
4-
information for someone not following this development to understand.
5-
Lines should be wrapped at about 72 characters. ]
3+
### Specific notes
64

7-
User interface changes?: [ No/Yes ]
8-
[ If yes, describe what changed, and steps taken to ensure backward compatibilty ]
5+
Contributors other than yourself, if any:
96

107
Fixes: [Github issue #s] And brief description of each issue.
118

12-
Testing:
13-
unit tests:
14-
system tests:
15-
manual testing:
9+
User interface changes?: [ No/Yes ]
10+
[ If yes, describe what changed, and steps taken to ensure backward compatibility ]
11+
12+
Testing performed (automated tests and/or manual tests):
1613

0 commit comments

Comments
 (0)