Skip to content

Commit 4780839

Browse files
author
Eric Wendelin
committed
Updating Contributing guide.
1 parent ac8c2c6 commit 4780839

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Submitting bugs
2+
Please include the following information to help us reproduce and fix:
3+
4+
* What you did
5+
* What you expected to happen
6+
* What actually happened
7+
* Browser and version
8+
* Example code that reproduces the problem (if possible)
9+
* *(l33t mode)* A failing test
10+
11+
## Making contributions
12+
Want to be listed as a *Contributor*? Make a pull request with:
13+
14+
* Unit and/or functional tests that validate changes you're making.
15+
* Run unit tests in the latest IE, Firefox, Chrome, Safari and Opera and make sure they pass.
16+
* Rebase your changes onto origin/HEAD if you can do so cleanly.
17+
* If submitting additional functionality, provide an example of how to use it.
18+
* Please keep code style consistent with surrounding code.
19+
20+
## Dev Setup
21+
* Make sure you have [NodeJS v0.10](http://nodejs.org/) installed
22+
* Run `npm install` from the project directory
23+
24+
## Testing
25+
* (Local) Run `make test`. Make sure [Karma Local Config](karma.conf.js) has the browsers you want.
26+
* (Any browser, remotely) If you have a [Sauce Labs](https://saucelabs.com) account, you can run `make ci`.
27+
Make sure the target browser is enabled in [Karma CI Config](karma.conf.ci.js).
28+
Otherwise, Travis will run all browsers if you submit a Pull Request.

0 commit comments

Comments
 (0)