diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..23f4ffb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,59 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug]: " +labels: ["bug", "needs triage"] +body: + - type: markdown + attributes: + value: | + > _Thanks for filing a bug ticket. We appreciate your time and effort. Please answer a few questions._ + - type: dropdown + id: checked-for-duplicates + attributes: + label: Checked for duplicates + description: Have you checked for duplicate issue tickets? + multiple: false + options: + - "Yes - I've already checked" + - "No - I haven't checked" + validations: + required: yes + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. Plain-text snippets preferred but screenshots welcome. + placeholder: Tell us what you saw + value: "When I did [...] action, I noticed [...]" + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: What did you expect? + description: A clear and concise description of what you expect to happen + placeholder: Tell us what you expected + value: "I expected [...]" + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproducible steps + description: "How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets preferred but screenshots welcome." + value: | + 1. + 2. + 3. + ... + render: bash + - type: textarea + id: environment + attributes: + label: Environment + description: "What is your environment?" + value: | + - Version of this software [e.g. vX.Y.Z] + - Operating System: [e.g. MacOSX with Docker Desktop vX.Y] + ... + render: bash diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..4d8ea8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,48 @@ +name: New Feature +description: Submit a new feature request +title: "[New Feature]: " +labels: ["enhancement", "needs triage"] +body: + - type: markdown + attributes: + value: | + > _Thanks for filing a new feature request. We appreciate your time and effort. Please answer a few questions._ + - type: dropdown + id: checked-for-duplicates + attributes: + label: Checked for duplicates + description: Have you checked for duplicate issue tickets? + multiple: false + options: + - "Yes - I've already checked" + - "No - I haven't checked" + validations: + required: yes + - type: dropdown + id: checked-alternatives + attributes: + label: Alternatives considered + description: Have you considered alternative solutions to your feature request? + options: + - "Yes - and alternatives don't suffice" + - "No - I haven't considered" + validations: + required: yes + - type: textarea + id: related-problems + attributes: + label: Related problems + description: Is your feature request related to any problems? Please help us understand if so, including linking to any other issue tickets. + placeholder: Tell us the problems + value: "I'm frustrated when [...] happens as documented in issue-XYZ" + validations: + required: false + - type: textarea + id: description + attributes: + label: Describe the feature request + description: A clear and concise description of your request. + placeholder: Tell us what you want + value: "I need or want [...]" + validations: + required: true