From b547b258a6a953e2eef3b619bc19c677cc08d8cf Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Tue, 5 Jan 2021 12:25:30 -0500 Subject: [PATCH 1/2] Update GitHub Issue templates Update the templates to reflect the changes made in https://github.com/cisagov/.github/pull/11 --- .github/ISSUE_TEMPLATE/bug.md | 22 ++++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .github/ISSUE_TEMPLATE/feature.md | 20 ----------------- .github/ISSUE_TEMPLATE/issue.md | 29 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 14 ------------ .github/ISSUE_TEMPLATE/regression.md | 33 ---------------------------- 6 files changed, 46 insertions(+), 77 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/issue.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md delete mode 100644 .github/ISSUE_TEMPLATE/regression.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index ac63858e..52041af1 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,27 +1,29 @@ --- name: 🐛 Bug report -about: Create a report to help us improve +about: Describe a bug, error, unexpected behavior, or other problem --- -# 🐛 Bug Report +# 🐛 Summary # -A clear and concise description of what the bug is. +What's wrong? Please be specific. -## To Reproduce +## To reproduce ## Steps to reproduce the behavior: -- Do this -- Then this +1. Do this +1. Then this -## Expected behavior +## Expected behavior ## -A clear and concise description of what you expected to happen. +What did you expect to happen that didn't? -## Any helpful log output +## Any helpful log output or screenshots ## Paste the results here: -```bash +```console ``` + +Add any screenshots of the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..f6220c4b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Questions & Help + url: https://github.com/cisagov/.github/blob/develop/QUESTIONS.md + about: If you have questions, visit GitHub Discussions and Wiki pages diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index f15f08dc..00000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: 🚀 Feature Proposal -about: Submit a proposal for a new feature ---- - -# 🚀 Feature Proposal - -A clear and concise description of what the feature is. - -## Motivation - -Please outline the motivation for the proposal. - -## Example - -Please provide an example for how this feature would be used. - -## Pitch - -Why does this feature belong in this project? diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md new file mode 100644 index 00000000..287e0c39 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue.md @@ -0,0 +1,29 @@ +--- +name: 💡 Idea +about: Describe an idea, todo, feature, task, improvement, issue, epic, or story +--- + +# 💡 Summary # + +What is the work, as a high-level summary? + +## Motivation ## + +Why does this work belong in this project? + +This would be useful because... + +## Implementation notes ## + +Please provide details for implementation, such as: + +- an example for how this would be used +- what this would look like +- how this would act +- any related work, including links to related issues + +## Acceptance criteria ## + +How do we know when this work is done? + +- [ ] Criterion diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index bd0dcdb1..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: 💬 Questions / Help -about: If you have questions, please send us an Email ---- - -# 💬 Questions and Help - -## Please note that this issue tracker is not a help forum - -## This issue will be closed - -## For questions or help please use the contacts below - -- ✉️ [Email NCATS support](mailto:ncats_info@hq.dhs.gov) diff --git a/.github/ISSUE_TEMPLATE/regression.md b/.github/ISSUE_TEMPLATE/regression.md deleted file mode 100644 index 5f8af400..00000000 --- a/.github/ISSUE_TEMPLATE/regression.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: 💥 Regression Report -about: Report unexpected behavior that worked in previous versions ---- - -# 💥 Regression Report - -A clear and concise description of what the regression is. - -## Last working version - -Worked up to version: - -Stopped working in version: - -## To Reproduce - -Steps to reproduce the behavior: - -- Do this -- Then this - -## Expected behavior - -A clear and concise description of what you expected to happen. - -## Any helpful log output - -Paste the results here: - -```bash - -``` From 948d24f117242f15b12237c6463fe1fdd69a4d21 Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Wed, 6 Jan 2021 12:08:51 -0500 Subject: [PATCH 2/2] Add link to the cyhy-system repository Issues for this project should be infrastructure- related only. This adds a link to the cisagov/cyhy-system issues page to encourage CyHy environment issues to be created there instead. --- .github/ISSUE_TEMPLATE/config.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f6220c4b..7b51ee9a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: false contact_links: + - name: Submit an issue for the CyHy environment. + url: https://github.com/cisagov/cyhy-system/issues + about: Non-infrastructure issues should be made in the linked repository. - name: 💬 Questions & Help url: https://github.com/cisagov/.github/blob/develop/QUESTIONS.md about: If you have questions, visit GitHub Discussions and Wiki pages