forked from anijs/anijs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
46155c8
commit 0cc335c
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
Contributing to AniJS | ||
===================== | ||
|
||
AniJS is like a little girl, she needs [hungry and foolish](http://www.youtube.com/watch?v=7CeNIDWtlo0#t=774) community people to grow up healthy. All your [issues](https://github.com/anijs/anijs/issues), [pull requests](https://github.com/anijs/anijs/pulls) and [stars ;) ](https://github.com/anijs/anijs) are welcome. | ||
|
||
1. Fork it! | ||
2. Create your feature branch: `git checkout -b my-new-feature` | ||
3. Test your changes. | ||
4. Commit your changes: `git commit -am 'Add some feature'` | ||
5. Push to the branch: `git push origin my-new-feature` | ||
6. Submit a pull request :D | ||
|
||
Testing your changes | ||
-------------------- | ||
AniJS uses the [Jasmine](http://jasmine.github.io/) Behavior Driven Development testing framework. | ||
|
||
- Open test/jasmine-standalone/SpecRunner.html in a browser and then run the tests. | ||
|
||
- You can add your own tests spec in test/jasmine-standalone/spec. | ||
|
||
Please take a look to [Jasmine Documentation](http://jasmine.github.io/2.0/introduction.html) for further information. | ||
|
||
Pull Request Requirements | ||
------------------------- | ||
* Complete inline code comments | ||
* Unit tests with 80% line coverage | ||
* Proper commit logs |