Skip to content

Update issue & PR templates #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
May 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report, CESM-wide or unknown component
about: Report a problem with CESM for an unknown component; in many cases, one of the links below is more appropriate

---

### Brief summary of bug

[Give a one or two sentence summary. This could be the same as the issue title if you feel that is a sufficient summary.]

### General bug information

**CESM version you are using:** [Output of `git describe`]

**Machine you are using:** [Fill this in]

**Have you modified the code? (If so, please point us to you changes.):** [Yes / No]

### Details of bug

[Fill in details here.]

### Steps to reproduce the problem. Include externals description file(s) and link to public repository

[Fill this in with anything relevant that you haven't already noted; if there is nothing to add, delete this section.]

### Screen output or log file showing the error message and context

[Fill this in with anything relevant that you haven't already noted; if there is nothing to add, delete this section.]
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/02_enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: Enhancement request, CESM-wide or unknown component
about: Suggest a CESM-wide enhancement; in many cases, one of the links below is more appropriate

---


41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
blank_issues_enabled: true
contact_links:
- name: CESM forums
url: https://bb.cgd.ucar.edu/cesm/
about: For support with model use, troubleshooting, etc., please use the CESM forums
- name: CIME issue
url: https://github.com/ESMCI/cime/issues/new/choose
about: Issue with CIME (scripting infrastructure, share code, etc.)
- name: CAM issue
url: https://bb.cgd.ucar.edu/cesm/forums/cam.133/
about: Issue with CAM (Community Atmosphere Model) - please report via forums
- name: CTSM / CLM issue
url: https://github.com/ESCOMP/CTSM/issues/new/choose
about: Issue with CTSM / CLM (Community Terrestrial Systems Model / Community Land Model)
- name: POP issue
url: https://github.com/ESCOMP/POP2-CESM/issues/new/choose
about: Issue with POP in CESM (Parallel Ocean Program)
- name: MOM issue
url: https://github.com/ESCOMP/MOM_interface/issues/new/choose
about: Issue with MOM in CESM (Modular Ocean Model)
- name: CICE5 issue
url: https://github.com/ESCOMP/CESM_CICE5/issues/new/choose
about: Issue with CICE5
- name: CISM issue
url: https://github.com/ESCOMP/cism-wrapper/issues/new/choose
about: Issue with CISM (Community Ice Sheet Model)
- name: MOSART issue
url: https://github.com/ESCOMP/MOSART/issues/new/choose
about: Issue with MOSART in CESM (Model for Scale Adaptive River Transport)
- name: RTM issue
url: https://github.com/ESCOMP/RTM/issues/new/choose
about: Issue with RTM (River Transport Model)
- name: WW3 issue
url: https://github.com/ESCOMP/WW3-CESM/issues/new/choose
about: Issue with WW3 in CESM (WaveWatch III)
- name: CMEPS issue
url: https://github.com/ESCOMP/CMEPS/issues/new/choose
about: Issue with CMEPS (NUOPC Community Mediator for Earth Prediction Systems )
- name: FMS issue
url: https://github.com/ESCOMP/FMS_interface/issues/new/choose
about: Issue with FMS in CESM
17 changes: 7 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
[ 50 character, one line summary ]
### Description of changes

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

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

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

Testing:
unit tests:
system tests:
manual testing:
User interface changes?: [ No/Yes ]
[ If yes, describe what changed, and steps taken to ensure backward compatibility ]

Testing performed (automated tests and/or manual tests):