From a47f53c7ef501e8ebcff3ca1d24c16154fb472ba Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Thu, 15 Jul 2021 12:08:44 +0200 Subject: [PATCH] chore: update issue template --- .github/ISSUE_TEMPLATE/bug-report.md | 38 -------------------- .github/ISSUE_TEMPLATE/bug-report.yml | 52 +++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 38 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 55548a3e..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: 🐞Bug report -about: There's a bug I want to report -labels: triage ---- - -**Describe the bug** - - - -**To Reproduce** - - - -Code to reproduce the behaviour: - -```js -// formatted code snippet that reproduces the behaviour -``` - -**Expected behaviour** -A clear and concise description of what you expected to happen. - -**Environment:** - -- `jose` version: [e.g. v3.0.0] -- affected runtime is: [e.g. Node.js 14.15.0, Chrome 86, or iOS 14 Safari] -- other relevant library versions: [e.g. webpack, typescript, electron, ...] - -**Additional context** -Add any other context about the problem here. - -- [ ] the bug is happening on latest `jose` too. -- [ ] i have searched the issues tracker on github for similar issues and couldn't find anything related. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..988b8a9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,52 @@ +name: 🐞Bug report +description: There's a bug I want to report +labels: triage +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report. Do not use this form to ask questions or make suggestions, use the [appropriate](https://github.com/panva/jose/issues/new/choose) Discussions Topic for those. + - type: textarea + attributes: + label: What happened? + description: A clear and concise description of what the bug is and what you expected to happen instead. + validations: + required: true + - type: input + attributes: + label: Version + description: What exact version of the library do you use? + placeholder: e.g. v3.14.0 + validations: + required: true + - type: dropdown + attributes: + label: Runtime + description: What javascript runtime are you seeing the problem on? + options: + - Node.js + - Browser + - Electron + - Other (I will specify below) + validations: + required: true + - type: input + attributes: + label: Runtime Details + description: More information about the runtime (e.g. node version, browser vendor and version, electron version, operating system) + validations: + required: true + - type: textarea + attributes: + label: Code to reproduce + description: Please copy and paste code to reproduce the issue. This will be automatically formatted into javascript code, so no need for backticks. + render: js + validations: + required: true + - type: checkboxes + attributes: + options: + - label: I have searched the issues tracker and discussions for similar topics and couldn't find anything related. + required: true + - label: I agree to follow this project's [Code of Conduct](https://github.com/panva/jose/blob/main/CODE_OF_CONDUCT.md) + required: true