aboutsummaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/feature-request.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE/feature-request.md')
-rw-r--r--.github/ISSUE_TEMPLATE/feature-request.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
new file mode 100644
index 0000000..86595f2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,39 @@
+---
+name: Feature Request
+about: 🎂 Ask nicely for something you reaaaaaaaally want
+
+---
+
+
+# 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 😃
+
+## **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.
+
+### 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))
+```