You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 21, 2022. It is now read-only.
Please don't edit files in the `dist` subdirectory as they are generated via Grunt. You'll find source code in the `src` subdirectory!
5
+
6
+
### Code style
7
+
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
8
+
9
+
### PhantomJS
10
+
While Grunt can run the included unit tests via [PhantomJS](http://phantomjs.org/), this shouldn't be considered a substitute for the real thing. Please be sure to test the `test/*.html` unit test file(s) in _actual_ browsers.
11
+
12
+
## Modifying the code
13
+
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
14
+
15
+
Test that Grunt's CLI is installed by running `grunt --version`. If the command isn't found, run `npm install -g grunt-cli`. For more information about installing Grunt, see the [getting started guide](http://gruntjs.com/getting-started).
16
+
17
+
1. Fork and clone the repo.
18
+
1. Run `npm install` to install all dependencies (including Grunt).
19
+
1. Run `grunt` to grunt this project.
20
+
21
+
Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken.
22
+
23
+
## Submitting pull requests
24
+
25
+
1. Create a new branch, please don't work in your `master` branch directly.
26
+
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
27
+
1. Fix stuff.
28
+
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
29
+
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
30
+
1. Update the documentation to reflect any changes.
0 commit comments