From d21de408bc25d74f09b6802bd6b62e43cbc0bbfe Mon Sep 17 00:00:00 2001 From: benwa Date: Fri, 10 Sep 2021 14:30:23 -0500 Subject: [PATCH] Update issue templates Using https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms --- .github/ISSUE_TEMPLATE/1-feature-request.md | 16 ------- .github/ISSUE_TEMPLATE/1-feature-request.yml | 21 +++++++++ .github/ISSUE_TEMPLATE/2-bug-report.md | 28 ----------- .github/ISSUE_TEMPLATE/2-bug-report.yml | 49 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/3-documentation.md | 8 ---- .github/ISSUE_TEMPLATE/3-documentation.yml | 10 ++++ .github/ISSUE_TEMPLATE/4-question.md | 16 ------- .github/ISSUE_TEMPLATE/4-question.yml | 10 ++++ 8 files changed, 90 insertions(+), 68 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/1-feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/1-feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/2-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/2-bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/3-documentation.md create mode 100644 .github/ISSUE_TEMPLATE/3-documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/4-question.md create mode 100644 .github/ISSUE_TEMPLATE/4-question.yml diff --git a/.github/ISSUE_TEMPLATE/1-feature-request.md b/.github/ISSUE_TEMPLATE/1-feature-request.md deleted file mode 100644 index 973fd31..0000000 --- a/.github/ISSUE_TEMPLATE/1-feature-request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: "🚀 Feature request" -labels: new-feature -about: I have a suggestion (and may want to implement it 🙂)! ---- - -### Feature Request - -**Problem statement.** -A clear and concise description of what the problem is. Ex. `I have an issue when [...]`, `As a WinSW user, I want to [...]` - -**Describe the solution you'd like.** -Add any considered drawbacks. - -**Describe alternatives you've considered.** -A clear and concise description of any alternative solutions or features you've considered. diff --git a/.github/ISSUE_TEMPLATE/1-feature-request.yml b/.github/ISSUE_TEMPLATE/1-feature-request.yml new file mode 100644 index 0000000..b05a037 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-feature-request.yml @@ -0,0 +1,21 @@ +name: 🚀 Feature request +description: I have a suggestion (and may want to implement it 🙂)! +labels: [new-feature] +body: + - type: textarea + attributes: + label: Problem statement + description: A clear and concise description of what the problem is. + placeholder: ex. I have an issue when [...], As a WinSW user, I want to [...] + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: Add any considered drawbacks. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.md b/.github/ISSUE_TEMPLATE/2-bug-report.md deleted file mode 100644 index ef935ab..0000000 --- a/.github/ISSUE_TEMPLATE/2-bug-report.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: "🐛 Bug report" -labels: bug -about: Create a bug report to help us improve ---- - -**Summary**. Describe the expected and actual behavior here. - -## Steps to reproduce - -Please clarify how to reproduce the issue. - -If you need to attach your configuration, please do it pelow: - -```xml -TODO -``` - -## Environment - -* WinSW version: TODO -* WinSW package type: TODO (e.g. .NET 4.6.1 ) -* Windows version: TODO -* Wrapped executable and version: TODO - -## Possible Solution - -If you have suggestions on a fix for the bug, please describe it here. diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml new file mode 100644 index 0000000..2bad5d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report.yml @@ -0,0 +1,49 @@ +name: 🐛 Bug report +description: Create a bug report to help us improve +labels: [bug] +body: + - type: textarea + attributes: + label: Summary + description: Describe the expected and actual behavior. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: Please clarify how to reporduce the issue. + validations: + required: true + - type: textarea + attributes: + label: Configuration + description: Paste your XML here + render: xml + - type: input + attributes: + label: WinSW version + validations: + required: true + - type: dropdown + attributes: + label: WinSW package type + options: + - .NET Framework + - .NET Core + validations: + required: true + - type: input + attributes: + label: Windows version + validations: + required: true + - type: input + attributes: + label: Wrapped executable and version + description: ex. Jenkins 2.222.1 + validations: + required: true + - type: textarea + attributes: + label: Possible solution + description: If you have suggestions on a fix for the bug, please describe it here. diff --git a/.github/ISSUE_TEMPLATE/3-documentation.md b/.github/ISSUE_TEMPLATE/3-documentation.md deleted file mode 100644 index 810e586..0000000 --- a/.github/ISSUE_TEMPLATE/3-documentation.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: "📝 Documentation" -labels: documentation -about: Let us know if any documentation is missing or could be improved ---- - -**Summary**. Describe your use-case which is not covered by existing documentation. -If it is easier to submit a documentation patch instead of writing an issue, just do it! diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml new file mode 100644 index 0000000..17f505e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -0,0 +1,10 @@ +name: 📝 Documentation +description: Let us know if any documentation is missing or could be improved +labels: [documentation] +body: + - type: textarea + attributes: + label: Summary + description: Describe your use-case which is not covered by existing documentation. If it is easier to submit a documentation patch instead of writing an issue, just do it! + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/4-question.md b/.github/ISSUE_TEMPLATE/4-question.md deleted file mode 100644 index 7f5f9ed..0000000 --- a/.github/ISSUE_TEMPLATE/4-question.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: "❓ Need help" -labels: question -about: Please ask in our Gitter channel first ---- - ---- -We primarily use GitHub as an issue tracker. -For usage and support questions, please ask in our [Gitter chat](https://gitter.im/winsw/winsw) first. -Thanks! ---- - -### Problem statement - -Please describe your issue here, and explain what you have already tried to resolve it. - diff --git a/.github/ISSUE_TEMPLATE/4-question.yml b/.github/ISSUE_TEMPLATE/4-question.yml new file mode 100644 index 0000000..5028841 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-question.yml @@ -0,0 +1,10 @@ +name: ❓ Need help +description: Please ask in our Gitter channel first +labels: [question] +body: + - type: textarea + attributes: + label: Problem statement + description: Please describe your issue here, and explain what you have already tried to resolve it. + validations: + required: true