From 75348c73831e7262bde99f2f6ab6f538959c79ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastian=20M=C3=BCller?= Date: Tue, 19 Sep 2023 14:41:17 -0700 Subject: [PATCH] improve issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 28 ------------ .github/ISSUE_TEMPLATE/bug-report.yaml | 49 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 27 ------------ .github/ISSUE_TEMPLATE/feature-request.yaml | 30 +++++++++++++ 4 files changed, 79 insertions(+), 55 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 78b28e25..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Reporting a Problem/Bug -about: Reporting a Problem/Bug -title: '' -labels: bug, Feedback -assignees: '' - ---- - -## Instructions - -Please fill out the template below to the best of your ability and include a label indicating which tool/service you were working with when you encountered the problem. - -### Problem - - - -### Steps to Reproduce - - - -### Acceptance Criteria - - - -### Context - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000..1834dadd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,49 @@ +name: Reporting a Problem/Bug +title: "[] " +description: Reporting a Problem/Bug +labels: [Bug, Feedback] +assignees: onflow/cadence +body: + - type: markdown + attributes: + value: | + > **Warning** + > Do you experience a **crash** in Cadence? + > Please do **NOT** report a crasher as a bug! + > + > Instead, report it as a security issue: + > https://flow.com/flow-responsible-disclosure + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: Please share any details and steps that can reproduce the problem + placeholder: | + 1. When running a transaction with the following code... + 2. See error... + validations: + required: true + - type: textarea + attributes: + label: Environment + description: | + Example: + - **Cadence version**: v0.31.2 + - **Network**: Emulator + value: | + - Cadence version: + - Network: + render: markdown + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index f88a8b8c..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Requesting a Feature or Improvement -about: "For feature requests. Please search for existing issues first. Also see CONTRIBUTING." -title: '' -labels: Feedback, Feature -assignees: '' - ---- - -## Instructions - -Please fill out the template below to the best of your ability and include a label indicating which tool/service you were working with when you encountered the problem. - -### Issue To Be Solved -(Replace This Text: Please present a concise description of the problem to be addressed by this feature request. Please be clear what parts of the problem are considered to be in-scope and out-of-scope.) - -### (Optional): Suggest A Solution -(Replace This Text: A concise description of your preferred solution. Things to address include: -* Details of the technical implementation -* Tradeoffs made in design decisions -* Caveats and considerations for the future - -If there are multiple solutions, please present each one separately. Save comparisons for the very end.) - -### (Optional): Context - -<what are you currently working on that this is blocking?> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 00000000..4c895f70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,30 @@ +name: Requesting a Feature or Improvement +title: "[<TOOL NAME>] <TITLE>" +description: For feature requests. Please search for existing issues first. Also see CONTRIBUTING. +labels: [Feature, Feedback] +assignees: onflow/cadence +body: + - type: markdown + attributes: + value: | + Please fill out the template below to the best of your ability. + - type: textarea + attributes: + label: Issue to be solved + description: | + Please present a concise description of the problem to be addressed by this feature request. + Please be clear what parts of the problem are considered to be in-scope and out-of-scope. + validations: + required: true + - type: textarea + attributes: + label: Suggested Solution + description: | + A concise description of your preferred solution. Things to address include: + * Details of the technical implementation + * Tradeoffs made in design decisions + * Caveats and considerations for the future + + If there are multiple solutions, please present each one separately. Save comparisons for the very end. + validations: + required: false