From d0d6e834d4a557cd092e7273839b0106f1825d2f Mon Sep 17 00:00:00 2001 From: Robert Kieffer Date: Mon, 23 May 2022 13:02:37 -1000 Subject: [PATCH] chore: use github form syntax for better issue templates (#637) --- .github/ISSUE_TEMPLATE/bug_report.md | 34 ------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 39 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 ------------- .github/ISSUE_TEMPLATE/feature_request.yml | 13 ++++++++ 4 files changed, 52 insertions(+), 57 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c22adba3..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' ---- - - - -## Describe the bug - -[Clear, concise description of the problem] - -## How to reproduce - -**REQUIRED**: Provide a [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/minimal-reproducible-example) example so that we (the `uuid` maintainers) can reproduce the problem. Issues that do not provide this will be closed without investigation. - -## Expected behavior - -[Clear, concise description of what you expected] - -## Runtime - -- OS: [e.g. macOS, Linux] -- Runtime: [e.g. Node.js, Chrome, Safari, react-native, AWS Lambda] -- Runtime Version: [e.g. 14.2.0] - -## Additional information - -[Any other information or comments that you think will help] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..c10076fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,39 @@ +name: Bug report +description: File a bug against the `uuid` project +labels: ["bug"] +title: "[BUG] " + +body: +- type: checkboxes + attributes: + label: Before you begin... + options: + - label: I have searched the existing issues + required: true + - label: I am not using version 13.x of node (if so, please upgrade) + required: true + +- type: textarea + attributes: + label: Description of the problem + validations: + required: false + +- type: textarea + attributes: + label: Recipe for reproducing + description: "**IMPORTANT**: Failure to provide a [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/minimal-reproducible-example) example will result in this issue being closed without further review." + render: bash + validations: + required: false + +- type: textarea + attributes: + label: Additional information + +- type: textarea + attributes: + label: Environment + description: "Output of `npx envinfo --system --browsers --npmPackages --binaries` goes here:" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f7742f6d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' ---- - -## Is your feature request related to a problem? Please describe. - -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -## Describe the solution you'd like - -A clear and concise description of what you want to happen. - -## Describe alternatives you've considered - -A clear and concise description of any alternative solutions or features you've considered. - -## Additional context - -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..25947fbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,13 @@ +name: Feature request +description: Suggest an idea for this project +labels: ["feature"] + +body: +- type: textarea + attributes: + label: Feature description + +- type: textarea + attributes: + label: Additional information + description: E.g. alternatives you've considered, examples, screenshots, or anything else that may be helpful \ No newline at end of file