From 0fdaed9c0f854308da75673a3d353fd4ad39eb8a Mon Sep 17 00:00:00 2001 From: Sam Rabin Date: Thu, 22 May 2025 11:17:35 -0600 Subject: [PATCH 1/4] Rename "other" template to make room. --- .github/ISSUE_TEMPLATE/{03_other.md => 04_other.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{03_other.md => 04_other.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/03_other.md b/.github/ISSUE_TEMPLATE/04_other.md similarity index 100% rename from .github/ISSUE_TEMPLATE/03_other.md rename to .github/ISSUE_TEMPLATE/04_other.md From 59093a82d16f5301c6441998d65431fb8351001d Mon Sep 17 00:00:00 2001 From: Sam Rabin Date: Thu, 22 May 2025 11:23:46 -0600 Subject: [PATCH 2/4] Add issue template for docs. --- .github/ISSUE_TEMPLATE/03_documentation.md | 24 ++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/03_documentation.md diff --git a/.github/ISSUE_TEMPLATE/03_documentation.md b/.github/ISSUE_TEMPLATE/03_documentation.md new file mode 100644 index 0000000000..963249f05a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_documentation.md @@ -0,0 +1,24 @@ +--- +name: Documentation +about: Something should be added to or fixed in the documentation + +--- + + +**What sort(s) of issue is this?** +- [ ] Something is missing. +- [ ] Something is (or might be) incorrect. +- [ ] Something is confusing. +- [ ] Something is broken. + +**What part(s) of the documentation does this concern?** +- [ ] [Technical Note](https://escomp.github.io/ctsm-docs/versions/master/html/tech_note/index.html) (science and design of the model) +- [ ] [User's Guide](https://escomp.github.io/ctsm-docs/versions/master/html/users_guide/index.html) (using the model and related tools) +- [ ] Somewhere else (e.g., README file, tool help text, or code comment): _Please specify_ +- [ ] I don't know + +**Describe the issue** +A clear and concise description of what is missing or wrong. + +**Additional context (optional)** +Add any other context or screenshots about the issue here. From c87bdd587c86b59d316538703c3226884d2c83e3 Mon Sep 17 00:00:00 2001 From: Sam Rabin Date: Thu, 22 May 2025 11:27:20 -0600 Subject: [PATCH 3/4] Use headings instead of bold. --- .github/ISSUE_TEMPLATE/03_documentation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/03_documentation.md b/.github/ISSUE_TEMPLATE/03_documentation.md index 963249f05a..3d423ec463 100644 --- a/.github/ISSUE_TEMPLATE/03_documentation.md +++ b/.github/ISSUE_TEMPLATE/03_documentation.md @@ -5,20 +5,20 @@ about: Something should be added to or fixed in the documentation --- -**What sort(s) of issue is this?** +### What sort(s) of issue is this? - [ ] Something is missing. - [ ] Something is (or might be) incorrect. - [ ] Something is confusing. - [ ] Something is broken. -**What part(s) of the documentation does this concern?** +### What part(s) of the documentation does this concern? - [ ] [Technical Note](https://escomp.github.io/ctsm-docs/versions/master/html/tech_note/index.html) (science and design of the model) - [ ] [User's Guide](https://escomp.github.io/ctsm-docs/versions/master/html/users_guide/index.html) (using the model and related tools) - [ ] Somewhere else (e.g., README file, tool help text, or code comment): _Please specify_ - [ ] I don't know -**Describe the issue** +### Describe the issue A clear and concise description of what is missing or wrong. -**Additional context (optional)** +### Additional context (optional) Add any other context or screenshots about the issue here. From 6bf7ff34256a295d0ec8dd30937fd692315a0ca0 Mon Sep 17 00:00:00 2001 From: Sam Rabin Date: Thu, 22 May 2025 11:28:16 -0600 Subject: [PATCH 4/4] Delete "documentation" from "other" template description. --- .github/ISSUE_TEMPLATE/04_other.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/04_other.md b/.github/ISSUE_TEMPLATE/04_other.md index 61898d3a75..f2cfcc7407 100644 --- a/.github/ISSUE_TEMPLATE/04_other.md +++ b/.github/ISSUE_TEMPLATE/04_other.md @@ -1,6 +1,6 @@ --- name: Other -about: Other issues (enhancement, cleanup, documentation, etc.) +about: Other issues (enhancement, cleanup, etc.) ---