From dc926194861e54d3f4228416840766bc99d9692a Mon Sep 17 00:00:00 2001 From: Artur Arseniev Date: Tue, 31 Aug 2021 12:13:08 +0200 Subject: [PATCH] Update issue template --- .github/ISSUE_TEMPLATE/01_bug_report.md | 36 ----------- .github/ISSUE_TEMPLATE/02_feature_request.md | 28 --------- .github/ISSUE_TEMPLATE/1.bug_report.yml | 63 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++ .github/config.yml | 1 - 5 files changed, 74 insertions(+), 65 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/1.bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/config.yml diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.md b/.github/ISSUE_TEMPLATE/01_bug_report.md deleted file mode 100644 index 96458e41a..000000000 --- a/.github/ISSUE_TEMPLATE/01_bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: 🐜 Bug report -about: If something is not working as excepted -title: 'BUG: ' ---- - -## WARNING -READ and FOLLOW next 3 steps, then REMOVE them before posting the issue - -1. Follow CONTRIBUTING Guidelines https://github.com/artf/grapesjs/blob/master/CONTRIBUTING.md -2. Do a quick SEARCH first, to see if someone else didn't open the same issue -3. All relative statements/questions have to be filled/answered, otherwise, the issue might be CLOSED -4. JSFiddle Starter template https://jsfiddle.net/szLp8h4n -5. CodeSandbox Starter template https://codesandbox.io/s/1r0w2pk1vl - -**Version:** - -*You can get the version by typing `grapesjs.version` into the console* - -**Are you able to reproduce the bug from the demo?** - - - [ ] Yes - - [ ] No - -**What is the expected behavior?** - -*Describe the bug **detailed*** - -**What is the current behavior?** - -*Describe the bug **detailed*** - -**Are you able to attach screenshots, screencasts or a live demo?** - - - [ ] Yes (attach) - - [ ] No diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md deleted file mode 100644 index 5d49b2b2a..000000000 --- a/.github/ISSUE_TEMPLATE/02_feature_request.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: 🚀 Feature request -about: If you have a feature request -title: 'FEAT: ' ---- - -## WARNING -READ and FOLLOW next 3 steps, then REMOVE them before posting the issue - -1. Follow CONTRIBUTING Guidelines https://github.com/artf/grapesjs/blob/master/CONTRIBUTING.md -2. Do a quick SEARCH first, to see if someone else didn't open the same issue -3. All relative statements/questions have to be filled/answered, otherwise, the issue might be CLOSED -4. JSFiddle Starter template https://jsfiddle.net/szLp8h4n -5. CodeSandbox Starter template https://codesandbox.io/s/1r0w2pk1vl - -**What are you trying to add to GrapesJS?** - -*Describe your feature request **detailed*** - -**Is there an alternative at the latest version?** - - - [ ] Yes (describe the alternative) - - [ ] No - -**Is this related to an issue?** - - - [ ] Yes (Give a link to the issue) - - [ ] No diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml new file mode 100644 index 000000000..78dcdf5b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -0,0 +1,63 @@ +name: 🐞 Bug report +description: Create a bug report for GrapesJS. +title: "BUG: " +labels: [] +body: + - type: markdown + attributes: + value: | + In order to understand and fix the issue, we ask you to fill correctly all the statements/questions. + **If you don't indicate a reproducible demo with relative steps to reproduce the bug, the issue might be CLOSED.** + Note: before creating a bug issue, search in GitHub Issues to check if a similar bug was already reported. + - type: checkboxes + attributes: + label: GrapesJS version + description: | + As the bug you're facing might be already fixed, we ask you to ensure to use the latest version available (current version [![npm](https://img.shields.io/npm/v/grapesjs.svg)](https://www.npmjs.com/package/grapesjs)). + options: + - label: I confirm to use the latest version of GrapesJS + required: true + - type: input + attributes: + label: What browser are you using? + placeholder: ex. Chrome v91 + validations: + required: true + - type: input + attributes: + label: Reproducible demo link + description: | + Use one of these starter templates to create your demo: [JSFiddle](https://jsfiddle.net/szLp8h4n) - [CodeSandbox](https://codesandbox.io/s/1r0w2pk1vl). + You can also indicate one of our offical demos if the bug is reproducible there. + validations: + required: true + - type: textarea + attributes: + label: Describe the bug + description: | + Indicate, step by step, how to reproduce the bug, what is the expected behavior and which is the current one. + If you're also able to create a video of the issue, that would be extremely helpful. + value: | + **How to reproduce the bug?** + 1. ... + 2. ... + + **What is the expected behavior?** + ... + + **What is the current behavior?** + ... + + If is necessary to execute some code in order to reproduce the bug, paste it here below: + ```js + // your code here + ``` + validations: + required: true + - type: checkboxes + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/artf/grapesjs/blob/dev/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..96b1be2fb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: 🚀 Feature Request + url: https://github.com/artf/grapesjs/discussions/new?category=ideas + about: 'Suggest any ideas you have using our discussion forums.' + - name: 🙏 Help + url: https://github.com/artf/grapesjs/discussions/new?category=q-a + about: 'If you have a question or need help, ask a question on the discussion forums.' + - name: 📢 Show and tell + url: https://github.com/artf/grapesjs/discussions/new?category=show-and-tell + about: "Have something nice to say or share about GrapesJS? We'd love to hear it!" \ No newline at end of file diff --git a/.github/config.yml b/.github/config.yml deleted file mode 100644 index ec4bb386b..000000000 --- a/.github/config.yml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: false \ No newline at end of file