If you are thinking about making Karma better, or you just want to hack on it, that’s great!
Here are some tips to get you started.
Getting Started #
- Make sure you have a GitHub account
- Submit a ticket for your issue, assuming one does not
- 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
Making Changes #
- Checkout a new branch (usually based on
master) and name it accordingly to what
you intend to do
- Features get the prefix
- Bug fixes get the prefix
- Improvements to the documentation get the prefix
Testing and Building #
Run the tests via
$ 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.
Submitting Changes #
Contributor License Agreement #
Please sign our Contributor License Agreement (CLA) before sending pull requests.
For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!
Additional Resources #