From 5ef3fecf4c2a3dd8149953ce7c3a71a8c2fff796 Mon Sep 17 00:00:00 2001 From: Vitaliy Savitskiy Date: Sun, 11 Jun 2023 19:02:45 +0200 Subject: [PATCH] feat: add formalized issue template (#417) --- .github/ISSUE_TEMPLATE/bug_report.yaml | 40 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 39 ++++++++++++++++++++ 2 files changed, 79 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 00000000..2dafd44c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,40 @@ +name: Bug report +description: Create a bug report to help us to improve +title: "[BUG] ..." +labels: bug +body: + - type: textarea + attributes: + label: Description + description: | + Briefly describe the problem you are having in a few paragraphs. + validations: + required: true + + - type: textarea + attributes: + label: Code snippet that reproduces the issue + description: | + Write a runnable code example that reproduces unexpected behavior + validations: + required: true + + - type: textarea + attributes: + label: Describe the results you expected + validations: + required: true + + - type: input + attributes: + label: Python version you are using + placeholder: python --version + validations: + required: true + + - type: textarea + attributes: + label: Environment description + placeholder: python -m pip freeze + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..0895e23a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,39 @@ +name: Feature request +description: Suggest an idea for this project +title: "[FEATURE] ..." +labels: enhancement +body: + - type: textarea + attributes: + label: Description + description: Is your feature request related to a problem? Please describe. + value: I'm always frustrated when [...] + validations: + required: true + + - type: textarea + attributes: + label: Possible solution + description: | + Describe the solution you'd like. + A clear and concise description of what you want to happen. + validations: + required: false + + - type: textarea + attributes: + label: Alternatives + description: | + Describe alternatives you've considered + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + + - type: textarea + attributes: + label: Context + description: | + Additional context + Add any other context or screenshots about the feature request here. + validations: + required: false