Browse Source

Add new better issue templates

pull/2869/head
BerkeAras 6 years ago
parent
commit
3cf493f7a0
  1. 26
      .github/ISSUE_TEMPLATE.md
  2. 36
      .github/ISSUE_TEMPLATE/01_bug_report.md
  3. 26
      .github/ISSUE_TEMPLATE/02_feature_request.md
  4. 1
      .github/config.yml

26
.github/ISSUE_TEMPLATE.md

@ -1,26 +0,0 @@
## WARNING
READ and FOLLOW next 5 steps, then REMOVE them before posting the issue
1. Follow CONTRIBUTING Guidelines https://github.com/artf/grapesjs/blob/master/CONTRIBUTING.md
2. Use the GitHub Issues EXCLUSIVELY for BUGS, FEATURE REQUESTS or QUESTIONS. Prefix the title of the issue with its context, eg. `[Bug]: ....`
3. Do a quick SEARCH first, to see if someone else didn't open the same issue
4. DON'T ASK to create examples/code for you, read DOCS and APIs first, then you can post what you have tried (we'd like to see your code) and what you're unable to achieve
5. All relative statements/questions have to be filled/answered, otherwise, the issue might be CLOSED
## You're submitting a BUG
1. Are you using the latest release (older versions are NOT supported)?
1. If you're not sure, type `grapesjs.version` in console and press ENTER
1. Are you facing the bug with your local copy of GrapesJS or with the current demo?
1. If a local copy
1. Indicate all informations about your OS, browser and GrapesJS version.
1. Are you able to reproduce the bug from the demo?
1. What is the expected behavior?
1. What happens instead?
1. If you're able to reproduce the bug indicate all the necessary steps
1. Attach screenshots (using KAP/LICEcap), screencasts or live demo
1. JSFiddle Starter template https://jsfiddle.net/szLp8h4n
1. CodeSandbox Starter template https://codesandbox.io/s/1r0w2pk1vl
## You're submitting a FEATURE REQUEST
1. Be sure to work on the latest version, as the feature might be already there
1. Keep in mind that the feature should be considered valid to use for everyone, not only for your case

36
.github/ISSUE_TEMPLATE/01_bug_report.md

@ -0,0 +1,36 @@
---
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?**
*Descripe the bug **detailed***
**Are you able to attach screenshots, screencasts or a live demo?**
[ ] Yes (attach)
[ ] No

26
.github/ISSUE_TEMPLATE/02_feature_request.md

@ -0,0 +1,26 @@
---
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 (descripe the alternative)
[ ] No
**Is this related to an issue?**
[ ] Yes (Give a link to the issue)
[ ] No

1
.github/config.yml

@ -0,0 +1 @@
blank_issues_enabled: false
Loading…
Cancel
Save