From 322639a66a6d7748fac88e8c132c863c018ead0d Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Thu, 16 Feb 2023 22:01:29 +0300 Subject: [PATCH] dev: issue and feature request templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 60 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 58 ++++++++++++++++++++ 2 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..14e8cbe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,60 @@ +name: "🐛 Bug Report" +description: "Submit a bug report to help us improve" +#title: "[Bug] " +labels: [bug] +body: + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "⚠️ Please verify that this bug has NOT been reported before." + description: "Search in the issues sections by clicking [HERE](https://github.com/notashelf/neovim-flake4/issues?q=)" + options: + - label: "I checked all existing issues and didn't find a similar issue" + required: true + - type: textarea + id: description + validations: + required: false + attributes: + label: "Description" + description: "You could also upload screenshots, if necessary" + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "👟 Reproduction steps" + description: "How do you trigger this bug? Please walk us through the problem, step by step" + placeholder: "..." + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: "👀 Expected behavior" + description: "What did you think would or should happen?" + placeholder: "..." + - type: textarea + id: actual-behavior + validations: + required: true + attributes: + label: "😓 Actual Behavior" + description: "What actually happen?" + placeholder: "..." + - type: input + id: nix-metadata + attributes: + label: "💻 Metadata" + description: 'Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.' + placeholder: '[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"' + validations: + required: true + - type: textarea + id: logs + attributes: + label: "📝 Relevant log output" + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: bash + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..d7ed265 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,58 @@ +name: 🚀 Feature Request +description: "Propose a new feature" +#title: "[Feature] " +labels: [feature-request] +body: + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "⚠️ Please verify that this feature request has NOT been suggested before." + description: "Search in the issues sections by clicking [HERE](https://github.com/notashelf/neovim-flake/issues?q=)" + options: + - label: "I checked and didn't find a similar feature request" + required: true + - type: dropdown + id: feature-area + attributes: + label: "🏷️ Feature Type" + description: "What kind of a feature request is this?" + multiple: true + options: + - New Command + - New Addon + - API Additions + - Other + validations: + required: true + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: "🔖 Feature description" + description: "A clear and concise description of what your feature request is." + placeholder: "'You should add [...]' or '[...] has always frustrated me' " + - type: textarea + id: solution + validations: + required: true + attributes: + label: "✔️ Solution" + description: "A clear and concise description of what you want to happen." + placeholder: "In my use-case, I would like [...]" + - type: textarea + id: alternatives + validations: + required: false + attributes: + label: "❓ Alternatives" + description: "A clear and concise description of any alternative solutions or features you've considered." + placeholder: "I have considered [...]" + - type: textarea + id: additional-context + validations: + required: false + attributes: + label: "📝 Additional Context" + description: "Add any other context or screenshots about the feature request here." + placeholder: "..."