bootlint/CONTRIBUTING.md

Contributing

Important notes

Please don't edit files in the dist subdirectory as they are generated via Grunt. You'll find source code in the src subdirectory!

Code style

The project's coding style is laid out in the JSHint, ESLint, and JSCS configurations.

PhantomJS

Grunt can run the included unit tests via PhantomJS.

Modifying the code

First, ensure that you have the latest Node.js and npm installed.

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 with Grunt guide.

1. Fork and clone the repo.
2. Run npm install to install all build dependencies (including Grunt).
3. Run grunt to grunt this project.

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.

Submitting pull requests

1. Create a new branch, please don't work in your master branch directly.
2. Add failing tests for the change you want to make. See the test suite's README for instructions on how to do this. Run grunt to see the tests fail.
3. Fix stuff.
4. Run grunt to see if the tests pass. Repeat steps 2-4 until done.
5. Update the documentation to reflect any changes.
6. If you upgraded or added any dependencies in package.json, run grunt update-shrinkwrap and (in a separate commit) commit the updated /test-infra/npm-shrinkwrap.json file. This updates the package versions used by the Travis CI build.
7. Push to your fork and submit a pull request.

Licensing

By contributing your code, you agree to license your contribution under the MIT License.