diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 33 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 41 |
2 files changed, 74 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6536a0e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,33 @@ + +# Contributing + +When contributing to this repository, please first discuss the change you wish to make on gitter, or with an issue to increase your chances of getting your pull request merged into the main code base. + + +## Pull Request Process + +When you want to make contriubtions to the project, the process is pretty simple: + +1. Discuss in an issue or on gitter what you'd like to change +2. Fork the repository to make your own local copy +3. Make a branch in the format of <issue-number>-<friendly-name>. So for example if I made an issue to change the default color, and it was issue 385 (random) on the repo, the branch would be called `385-change-default-color` +4. Make the changes to the src and perhaps make a playground by duplicating the playgrounds we already have. + - Build the code during the development process with `npm run build:dev` so that we don't throw a huge number of pointless errors + - When you're done making changes, run `npm run build` to build the code and run the linter +5. If applicable - please write new tests, we like to keep our code well tested 🎉. Run the tests by either opening the SpecRunner.html file or just run `npm test`, either is fine. +6. Push the code and make a pull request on the main svg.js repo +7. Enjoy our endless love and gratitude ❤️ + +Seriously, we love pull requests! So go wild! + + +## Code of Conduct + +We only have a few simple rules, because we know you wouldn't want to read a whole code of conduct guide now would you? 🤡 + +- don't say anything you wouldn't want said to you +- If you think you can help, then we'd love it if you did! 😃 +- Respect everybody +- NEVER be rude + +If the contributors feel like you're doing anything rude, we have the right to delete/report your posts. So please just treat everybody nicely, and we can all be great friends! diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..f0a8e12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,41 @@ + +**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)) +``` |