From d43684fc9fb76090ecb6d96062bd57d947f2cf99 Mon Sep 17 00:00:00 2001 From: codingfabi Date: Sun, 5 May 2024 11:28:07 +0200 Subject: [PATCH] add templates and config --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 68 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 39 +++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 3 files changed, 108 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 0000000..ec14a8d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,68 @@ +name: "🐛 Bug Report" +description: Create a new ticket for a bug. +title: "BUG: " +labels: [ + "bug" +] +body: + - type: textarea + id: description + attributes: + label: "Description" + description: Please enter an explicit description of your issue + placeholder: Short and explicit description of your incident... + validations: + required: true + - type: textarea + id: reprod + attributes: + label: "Reproduction steps" + description: Please enter an explicit description of your issue + value: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + render: bash + validations: + required: true + - type: textarea + id: logs + attributes: + label: "Logs" + description: Please copy and paste any relevant log output or error messages. This will be automatically formatted into code, so no need for backticks. + render: bash + validations: + required: false + - type: textarea + id: package-version + attributes: + label: "Package Version" + description: What version of the package are you using? + placeholder: 1.0.0 + validations: + required: false + - type: dropdown + id: python-version + attributes: + label: "Python Version" + description: Which python version are you using? + multiple: true + options: + - 3.10 + - 3.11 + - 3.12 + validations: + required: false + - type: dropdown + id: os + attributes: + label: "OS" + description: What is the impacted environment ? + multiple: true + options: + - Windows + - Linux + - Mac + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 0000000..efd3b95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,39 @@ +name: "Feature Request" +description: Create a new ticket for a new feature request +title: "REQUEST: - <title>" +labels: [ + "enhancement" +] +body: + - type: textarea + id: summary + attributes: + label: "Summary" + description: Provide a brief explanation of the feature + placeholder: Describe in a few lines your feature request + validations: + required: true + - type: textarea + id: basic_example + attributes: + label: "Basic Example" + description: Indicate here some basic examples of your feature. + placeholder: A few specific words about your feature request. + validations: + required: true + - type: textarea + id: reference_issues + attributes: + label: "Reference Issues" + description: Common issues + placeholder: "#Issues IDs" + validations: + required: false + - type: textarea + id: unresolved_question + attributes: + label: "Unresolved questions" + description: What questions still remain unresolved ? + placeholder: Identify any unresolved issues. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false