Skip to content

Commit

Permalink
Add contribution guideline
Browse files Browse the repository at this point in the history
  • Loading branch information
wa0x6e committed Apr 24, 2016
1 parent cbc1b86 commit 18b76c1
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing to Cal-Heatmap

## Editing source file

All edition should be done on `src/cal-heatmap.js`.

**DO NOT** edit javascripts file located in the root, as they're built via grunt.

## Building final javascripts

Cal-Heatmap uses `grunt` to build final javascripts and stylesheets.

Install grunt via

npm install -g grunt-cli

then run

grunt build

## Tests

Cal-Heatmap is tested with [Qunit](https://qunitjs.com/).

Tests files are located in the `test` directory, and can be run by opening the `index.html` file.

If you want to add or edit existing tests, **do not** edit the `test/test.js` file. Instead, add them in `test/src`, under the corresponding module. Take a look at existing tests for reference.

You can then run `grunt build` to generate the final `test/test.js` file.

## Submitting changes

Submit your pull requests with only files located in `src` folders. Do not commit files generated by grunt (.js located in the root and `test/test.js`).

0 comments on commit 18b76c1

Please sign in to comment.