From 4e838c68fe09586eaeec4fabd243250ed183c0c5 Mon Sep 17 00:00:00 2001 From: Saivan Date: Mon, 28 May 2018 20:31:38 +1000 Subject: [PATCH] Updated the issue templates to have multiple possibilities --- .github/ISSUE_TEMPLATE/bug-report.md | 19 ++++++++ .../feature-request.md} | 18 ++++---- .github/ISSUE_TEMPLATE/issue-template.md | 46 ------------------- .github/ISSUE_TEMPLATE/other.md | 7 +++ 4 files changed, 34 insertions(+), 56 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/feature-request.md} (52%) delete mode 100644 .github/ISSUE_TEMPLATE/issue-template.md create mode 100644 .github/ISSUE_TEMPLATE/other.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..41e71e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,19 @@ +--- +name: Bug Report +about: 🐞 Report a bug that you found + +--- + +# Bug report + +> **Note: for support questions, please use [stackoverflow](https://stackoverflow.com/questions/tagged/svg.js) with the tag svg.js or head to our chat over at [gitter](https://gitter.im/svgdotjs/svg.js)**. + +## Fiddle + +Modify [this fiddle](https://jsfiddle.net/Fuzzy/s06mfv5u/) to demonstrate the problem clearly, just fork it and paste the resulting fiddle in your issue. Please make sure this is a **minimal example**, containing only the minimum necessary code to help us troubleshoot your problem. + +## Explanation + +- What is the behaviour you expect? +- What is happening instead? +- What error message are you getting? diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/feature-request.md similarity index 52% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/feature-request.md index f0a8e12..86595f2 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,22 +1,20 @@ +--- +name: Feature Request +about: 🎂 Ask nicely for something you reaaaaaaaally want -**Note: for support questions, please use [stackoverflow](https://stackoverflow.com/questions/tagged/svg.js) with the tag svg.js or head to our chat over at [gitter](https://gitter.im/svgdotjs/svg.js)**. You should only post here if you have a bug to report or a feature that you think would make the library better. +--- -Delete the section that isn't relevant to you and fill out the one that is 🎉 - -# Bug report - -- What is the expected behaviour? -- What is actually happening? -- What error message are you getting? -- Modify [this fiddle](https://jsfiddle.net/Fuzzy/s06mfv5u/) to demonstrate the problem clearly, just fork it and paste the resulting fiddle in your issue. # Feature request +> **Note: for support questions, please use [stackoverflow](https://stackoverflow.com/questions/tagged/svg.js) with the tag svg.js or head to our chat over at [gitter](https://gitter.im/svgdotjs/svg.js)**. + +If you want to make a feature request, here are some guidelines to make a good one: - Add example code and usage for feature requests to see how a user would use it - Tell us the benefits (everything is allowed) - Make a simple use case like the one below. Obviously your feature request shouldn't be so silly. But make it clear to the maintainers what you want added and how you plan to use it 😃 -## Drawing [Smiley the Meme](http://i0.kym-cdn.com/entries/icons/original/000/000/107/smily.jpg) +## **Example** Drawing [Smiley the Meme](http://i0.kym-cdn.com/entries/icons/original/000/000/107/smily.jpg) It would be cool if SVG.js could be used to easily draw smiley the meme, it would make my life so much easier when I want to have memes in my svg. diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md deleted file mode 100644 index 36a5856..0000000 --- a/.github/ISSUE_TEMPLATE/issue-template.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Issue Template -about: The main issue template for svg.js - ---- - -**Note: for support questions, please use [stackoverflow](https://stackoverflow.com/questions/tagged/svg.js) with the tag svg.js or head to our chat over at [gitter](https://gitter.im/svgdotjs/svg.js)**. You should only post here if you have a bug to report or a feature that you think would make the library better. - -Delete the section that isn't relevant to you and fill out the one that is 🎉 - -# Bug report - -- What is the expected behaviour? -- What is actually happening? -- What error message are you getting? -- Modify [this fiddle](https://jsfiddle.net/Fuzzy/s06mfv5u/) to demonstrate the problem clearly, just fork it and paste the resulting fiddle in your issue. - -# Feature request - -- Add example code and usage for feature requests to see how a user would use it -- Tell us the benefits (everything is allowed) -- Make a simple use case like the one below. Obviously your feature request shouldn't be so silly. But make it clear to the maintainers what you want added and how you plan to use it 😃 - -## Drawing [Smiley the Meme](http://i0.kym-cdn.com/entries/icons/original/000/000/107/smily.jpg) - -It would be cool if SVG.js could be used to easily draw smiley the meme, it would make my life so much easier when I want to have memes in my svg. - -### Benefits -- Drawing memes would be quick and easy -- Memes are funny - -I think the syntax to achieve this should be: - -```js -let meme = draw.meme({radius: 300, cx: 50, cy: 80, lookAt: [30, 50]}) -``` - -Then the user could easily change where the smiley is looking with: - -```js -meme.lookAt(50, 40) -// OR -meme.lookAt([30, 20]) -// OR -meme.lookAt(new SVG.Point(30, 20)) -``` diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md new file mode 100644 index 0000000..c45be61 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.md @@ -0,0 +1,7 @@ +--- +name: Other Issue +about: 🍺 Something else... + +--- + +> **Note: for support questions, please use [stackoverflow](https://stackoverflow.com/questions/tagged/svg.js) with the tag svg.js or head to our chat over at [gitter](https://gitter.im/svgdotjs/svg.js), if you have a bug report or feature request, use those templates**. -- 2.39.5