From b9a978d53fc8e1af15754a19c2c7a6bd9fbf6fa2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Uek=C3=B6tter?= Date: Thu, 15 Dec 2022 11:01:08 +0100 Subject: [PATCH] Improve Issue Templates (#31) --- .github/ISSUE_TEMPLATE.md | 20 --------- .github/ISSUE_TEMPLATE/bug.yml | 71 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + .github/ISSUE_TEMPLATE/feature.yml | 18 ++++++++ .github/ISSUE_TEMPLATE/infra.yml | 10 +++++ 5 files changed, 100 insertions(+), 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/ISSUE_TEMPLATE/infra.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 535ac0cf4..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,20 +0,0 @@ -### New Issue Checklist - -- [ ] I have searched for a similar issue in the [project](https://github.com/flutterchina/dio/issues) and found none - -### Issue Info - -| Info | Value | | -| ------------------------------ | ----------------------------------------------------- | ---- | -| Platform Name | e.g. flutter / ios / android | | -| Platform Version | e.g. 1.5.0 / 12.0 / 9.0 | | -| Dio Version | e.g. 2.1.0 / 1.0.17 | | -| Android Studio / Xcode Version | e.g. Android Studio 3.3.2 / Xcode 10.2.1 | | -| Repro rate | e.g. all the time (100%) / sometimes x% / only once | | -| Repro with our demo prj | e.g. does it happen with our demo project? | | -| Demo project link | e.g. link to a demo project that highlights the issue | | - -### Issue Description and Steps - -Please fill in the detailed description of the issue (full output of any stack trace, compiler error, ...) and the steps to reproduce the issue. - diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..97fe25543 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,71 @@ +name: 🐞 Bug Report +description: Tell us about something that's not working the way we (probably) intend. +labels: ["s: bug", "h: need triage"] +body: +- type: markdown + attributes: + value: | + 🧐 **Guidelines:** + + - Search through [existing issues](https://github.com/cfug/diox/issues) first to ensure that this bug has not been reported before. + - Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems". + - Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them. + - Provide as much context as possible in the fields below. Include screenshots, screen recordings, links, references, or anything else you may consider relevant. + - If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/cfug/diox/discussions/new) instead. + - type: dropdown + id: package + attributes: + label: Package + description: Which package has a problem? + options: + - diox + - cookie_manager + - http2_adapter + validations: + required: true + - type: input + id: version + attributes: + label: Version + placeholder: 1.2.3 + description: Which version of that package do you use? + validations: + required: true + - type: textarea + id: flutter_info + attributes: + label: Output of `flutter doctor -v` + description: Required when used with Flutter. The input is automatically formatted in code fences + render: shell + - type: input + id: dart_version + attributes: + label: Dart Version + placeholder: 1.2.3 + description: Which version of Dart do you use? + validations: + required: false + - type: textarea + id: repro + attributes: + label: Steps to Reproduce + description: How can we see what you're seeing? Specific is terrific. + placeholder: |- + 1. foo + 2. bar + 3. baz + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Result + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual Result + description: Logs? Screenshots? Yes, please. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 000000000..a49eab2f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..d8660e749 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,18 @@ +name: 💡 Feature Request +description: Tell us about a problem diox could solve but doesn't. +labels: ["s: feature"] +body: + - type: textarea + id: problem + attributes: + label: Request Statement + description: What problem could diox solve that it doesn't? + validations: + required: true + - type: textarea + id: expected + attributes: + label: Solution Brainstorm + description: We know you have bright ideas to share ... share away, friend. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/infra.yml b/.github/ISSUE_TEMPLATE/infra.yml new file mode 100644 index 000000000..d68866b48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/infra.yml @@ -0,0 +1,10 @@ +name: 👷 Infra +description: Something is wrong with the CI setup or could be improved +labels: ["s: infra"] +body: + - type: textarea + id: problem + attributes: + label: Request Statement + validations: + required: true