Add template for issues and PRs

Closes gh-551.
This commit is contained in:
Fagner Brack
2016-04-27 23:06:19 +10:00
parent 3f4eddeb6e
commit d489ea7295
3 changed files with 11 additions and 0 deletions

22
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,22 @@
Issues
------
If you've found a bug or have a great idea for a new feature that will help **all users** of impress.js, let us know by [adding your suggestion]
(https://github.com/bartaz/impress.js/issues/new) to the [issue tracker](https://github.com/bartaz/impress.js/issues).
Guidelines:
* If reporting a bug, please provide a [simplified example](https://sscce.org/) on [Pastebin](https://pastebin.com/) or [JsFiddle](https://jsfiddle.net/).
Pull Requests
-------------
[Pull Requests](https://help.github.com/articles/using-pull-requests/) should be opened against the [master branch]
(https://github.com/bartaz/impress.js/tree/master). But remember that the team will only accept code that fits the purpose of impress.js.
Guidelines:
* If proposing a feature, make sure to discuss that as an issue first.
* Create a new [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) for every separate change you make.
* Make sure impress.js runs successfully on as many browsers as you can test.
* Run `npm lint` to make sure the code is consistent with the project standards.