From ce10fe0047aefaf3d8cebfcbf738a47605df4618 Mon Sep 17 00:00:00 2001 From: sebthom Date: Sun, 29 Oct 2023 02:46:58 +0200 Subject: [PATCH] add issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 72 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 + .github/ISSUE_TEMPLATE/enhancement.yaml | 50 +++++++++++++++++ .github/workflows/build.yml | 1 + .github/workflows/codeql-analysis.yml | 1 + 5 files changed, 126 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..9e0c07b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,72 @@ +name: 🐞 Bug Report +description: File a bug report +title: "[BUG] " +labels: ["bug"] + +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this bug report! + + - type: textarea + id: expected-behaviour + attributes: + label: βœ”οΈ Expected Behaviour + description: What did you expect to happen? + placeholder: Please enter expected behaviour here... + validations: + required: true + + - type: textarea + id: actual-behaviour + attributes: + label: 🐞 Actual Behaviour + description: What did actually happen? + placeholder: Please enter actual behaviour here... + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: πŸ“‹ Steps to Reproduce + description: How can we reproduce the issue? + placeholder: Please enter steps to reproduce here... + validations: + required: true + + - type: dropdown + id: browsers + attributes: + label: πŸ“Ί What browsers are you seeing the problem on? (if applicable) + multiple: true + options: + - Chrome + - Microsoft Edge + + - type: dropdown + id: operating-system + attributes: + label: πŸ’» What operating systems are you seeing the problem on? (if applicable) + multiple: true + options: + - Linux + - MacOS + - Windows + + - type: textarea + id: logs + attributes: + label: πŸ“ƒ Relevant log output (if applicable) + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Second-Hand-Friends/kleinanzeigen-bot/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0db72d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +# disable blank issue creation +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/enhancement.yaml b/.github/ISSUE_TEMPLATE/enhancement.yaml new file mode 100644 index 0000000..7ecb5b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yaml @@ -0,0 +1,50 @@ +name: πŸ’‘ Enhancement Request +description: File a enhancement request for an existing feature +title: "[ENH] " +labels: [enhancement] + +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this enhancement request! + + - type: textarea + id: problem + attributes: + label: πŸ˜• Addressed Problem + description: Which problem does this request address? + placeholder: Please enter answer here... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: πŸ’‘ Suggested Solution + description: What solution do you suggest? + placeholder: Please enter answer here... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: πŸ”Ž Alternatives + description: Which Alternatives did you consider? + placeholder: Please enter answer here... + + - type: textarea + id: context + attributes: + label: πŸ—ΊοΈ Additional Context + description: Any relevant additional context information + placeholder: Please enter answer here... + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Second-Hand-Friends/kleinanzeigen-bot/blob/main/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 9ff3446..4694b00 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -15,6 +15,7 @@ on: paths-ignore: - '**/*.md' - '.github/*.yml' + - '.github/ISSUE_TEMPLATE/*' - '.github/workflows/codeql-analysis.yml' - '.github/workflows/update-python-deps.yml' pull_request: diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index fbacb5b..73ed72b 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -9,6 +9,7 @@ on: - '**' paths-ignore: - '**/*.md' + - '.github/ISSUE_TEMPLATE/*' - '.github/workflows/build.yml' - '.github/workflows/update-python-deps.yml' pull_request: