forked from karma-runner/karma
-
Notifications
You must be signed in to change notification settings - Fork 0
How to contribute
taichi edited this page Jan 15, 2013
·
5 revisions
If you are thinking about making Testacular better, or you just want to hack on it, that’s great here are some tips to get you started.
- Make sure you have a GitHub account
-
Submit a ticket for your issue, assuming one does not
already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Fork the repository on GitHub
-
Clone your fork
-
Install dependencies via
$ npm install
-
Install global dependencies via
$ npm install grunt-cli -g
- Checkout a new branch (usually based on
master
) and name it accordingly to what you intend to do- Features get the prefix
feature-
- Bug fixes get the prefix
fix-
- Improvements to the documentation get the prefix
docs-
- Features get the prefix
Run the tests via
# All tests
$ grunt test
$ grunt test:unit
$ grunt test:e2e
$ grunt test:client
Lint the files via
$ grunt lint
Build the project via
$ grunt build
The default task, just calling grunt
will run build lint test
.
If grunt fails, make sure grunt-0.4x is installed: https://github.com/gruntjs/grunt/wiki/Getting-started.
- One branch per feature/fix
- Follow http://nodeguide.com/style.html (with exception of 100 characters per line)
- Follow Testacular - Git Commit Msg Convention
- Send a pull request to the
master
branch.