Skip to content

Commit

Permalink
Tweak support needed issue template
Browse files Browse the repository at this point in the history
Important change: Take a note out of the yaml header (because this
prevented the issue template from being usable).

In addition: some formatting tweaks to make things appear better when
the issue is rendered (e.g., with "preview").
  • Loading branch information
billsacks committed Jun 21, 2018
1 parent 0c27067 commit 2cfe3cb
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions .github/ISSUE_TEMPLATE/02_support_needed.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
name: Support needed for model use
about: Ask for help with using CTSM
[NOTE: We have limited staff and ability to provide support!]

---
### NOTE: Be sure to read the relevant documentation and user forums:

### NOTE: Be sure to read the relevant documentation and user forums

We have limited staff and ability to provide support. Here are some resources that might provide help:
- User's Guide: https://escomp.github.io/ctsm-docs/doc/build/html/users_guide/index.html
- CLM Forum: https://bb.cgd.ucar.edu/forums/land-modeling-clm
- README files amongst the source code.
- GitHub CTSM issues:
- Also make sure this issue is unique to CTSM and not really an issue with CESM or CIME.
- README files amongst the source code
- GitHub CTSM issues: https://github.com/escomp/ctsm/issues/
- Also make sure this issue is unique to CTSM and not really an issue with CESM or CIME

### Details of support request

Expand All @@ -19,11 +21,9 @@ about: Ask for help with using CTSM

**CTSM version you are using:** [output of `git describe`]


**Have you made any modifications to code, xml files, etc.?** [Yes / No]

* [If Yes: Please point us to your modifications]
* [If Yes, ALSO NOTE: In general we can NOT support problems with modified code. Try to show the problem without modifications.]
[If Yes: Please point us to your modifications. However: In general we can NOT support problems with modified code. Try to show the problem without modifications.]

**If you are having problems with a specific case: Is your case on a machine accessible to most CTSM developers (e.g., an NCAR machine)?** [Yes / No]

Expand All @@ -33,5 +33,4 @@ If Yes:

- Location of run directory: [Fill this in]

* [If No: Please make sure you have included all important input and output needed to understand your issue, either by pasting it into the issue text, or by attaching relevant files.]
* [If No, ALSO NOTE: We are less likely to be able to reproduce your problem if the issue is NOT on an NCAR machine]
[If No: Please make sure you have included all important input and output needed to understand your issue, either by pasting it into the issue text, or by attaching relevant files. However: We are less likely to be able to reproduce your problem if the issue is NOT on an NCAR machine.]

0 comments on commit 2cfe3cb

Please sign in to comment.