From bb18f9d1642b09999aaff3962f46a1817a399d09 Mon Sep 17 00:00:00 2001 From: tycrek Date: Sat, 31 Jul 2021 11:35:13 -0600 Subject: [PATCH] improved issue templates --- .github/ISSUE_TEMPLATE/feature-request.yml | 11 +++ .github/ISSUE_TEMPLATE/feature_request.md | 12 --- .github/ISSUE_TEMPLATE/report-bug.md | 25 ------ .github/ISSUE_TEMPLATE/report-bug.yml | 100 +++++++++++++++++++++ 4 files changed, 111 insertions(+), 37 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/report-bug.md create mode 100644 .github/ISSUE_TEMPLATE/report-bug.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..6a62b5f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,11 @@ +name: Feature request +description: Suggest a new feature +title: "[FEATURE] Title" +labels: enhancement +body: +- type: textarea + attributes: + label: Description + description: Describe the feature you wish to see added. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 8f29de4..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Feature request -about: Suggest a new feature -title: "[FEATURE] Title" -labels: enhancement -assignees: '' - ---- - -## Describe the feature - -## Additional details diff --git a/.github/ISSUE_TEMPLATE/report-bug.md b/.github/ISSUE_TEMPLATE/report-bug.md deleted file mode 100644 index 4236fbb..0000000 --- a/.github/ISSUE_TEMPLATE/report-bug.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Report bug -about: Report a new bug. Check for duplicates before submitting! -title: "[BUG] Title" -labels: bug -assignees: '' - ---- - -## Expected Behavior - -## Actual Behavior - -## Steps to Reproduce the Problem - -1. -1. -1. - -## Specifications - -- **ass version**: -- **host OS**: (linux/windows/macos including versions and distros) -- **reverse proxy**: ("no" or the name of the proxy software) -- **Cloudflare?** yes/no diff --git a/.github/ISSUE_TEMPLATE/report-bug.yml b/.github/ISSUE_TEMPLATE/report-bug.yml new file mode 100644 index 0000000..2539993 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-bug.yml @@ -0,0 +1,100 @@ +name: Report bug +description: Report a new bug +title: "[BUG] Title" +labels: bug +body: +- type: markdown + value: "## Bug report" +- type: checkboxes + attributes: + label: Is there an existing Issue for this bug? + description: Search for an existing issue to avoid duplicates. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Expected behavior + description: What should happen? + validations: + required: true +- type: textarea + attributes: + label: Actual behavior + description: What happens instead? + validations: + required: true +- type: textarea + attributes: + label: Steps to reproduce + description: How can we reproduce this bug? + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: false +- type: textarea + attributes: + label: Logs (optional) + description: If any errors are encountered, please attach the logs + render: text +- type: markdown + value: "### Environment details" +- type: input + attributes: + label: ass version + description: Which version of ass does this bug occur in? + validations: + required: true +- type: dropdown + attributes: + label: Deployment + description: Manual install or Docker? + options: [Manual, Docker] + validations: + required: true +- type: dropdown + attributes: + label: File storage + description: Where are you storing files? + options: [Local, S3] + validations: + required: true +- type: input + attributes: + label: Operating system + description: What is the name and version of the OS? + placholder: i.e. Ubuntu 18.04, Windows 10 + validations: + required: true +- type: input + attributes: + label: Node version + description: What is the version of Node.js? + placeholder: i.e. v14.17.3 + validations: + required: true +- type: input + attributes: + label: StorageEngine + description: How are you storing your data? + placeholder: i.e. JSON, PostgreSQL, etc. +- type: checkboxes + attributes: + label: Reverse proxy + description: Are you using a reverse proxy? + options: + - label: I am using a reverse proxy +- type: input + attributes: + label: Reverse proxy software + description: If you are using a reverse proxy, what is the name and version? + placeholder: i.e. nginx 1.13.1 +- type: checkboxes + attributes: + label: Cloudflare + description: Are you a Cloudflare user? + options: + - label: I am using Cloudflare