Skip to content

Commit

Permalink
Contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
eriwen committed Sep 23, 2012
1 parent d701baa commit aed5673
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 18 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,16 @@
## Making contributions
When submitting your pull requests, please do the following to make it easier to incorporate your changes:

* Include unit and/or functional tests that validate changes you're making.
* Run unit tests in the latest IE, Firefox, Chrome, Safari and Opera and make sure they pass.
* Rebase your changes onto origin/HEAD if you can do so cleanly.
* If submitting additional functionality, provide an example of how to use it.
* Please keep code style consistent with surrounding code.

## Testing
There are a few ways to run tests:

* You can run tests in PhantomJS by simply running `gradlew test` from your favorite shell.
* Run tests with JSTestDriver using `gradlew jstd`
* Point any browser to `≤project dir>/test/TestStacktrace.html` for unit tests
* Point your browser to `≤project dir>/test/functional/index.html` for more real-world functional tests
19 changes: 1 addition & 18 deletions README.md
Expand Up @@ -60,7 +60,7 @@ It is currently tested and working on:

- Firefox (and Iceweasel) 0.9+
- Google Chrome 1+
- Safari 3.0+
- Safari 3.0+ (including iOS 1+)
- Opera 7+
- IE 5.5+
- Konqueror 3.5+
Expand All @@ -79,20 +79,3 @@ This project is made possible due to the efforts of these fine people:
* Johan Euphrosine
* Øyvind Sean Kinsey
* Victor Homyakov

### Making contributions
When submitting your pull requests, please do the following to make it easier to incorporate your changes:

* Include unit and/or functional tests that validate changes you're making.
* Run unit tests in the latest IE, Firefox, Chrome, Safari and Opera and make sure they pass.
* Rebase your changes onto origin/HEAD if you can do so cleanly.
* If submitting additional functionality, provide an example of how to use it.
* Please keep code style consistent with surrounding code.

### Testing
There are a few ways to run tests:

* You can run tests in PhantomJS by simply running `gradlew test` from your favorite shell.
* Run tests with JSTestDriver using `gradlew jstd`
* Point any browser to `≤project dir>/test/TestStacktrace.html` for unit tests
* Point your browser to `≤project dir>/test/functional/index.html` for more real-world functional tests

0 comments on commit aed5673

Please sign in to comment.