From 7fa2e776878924083404ef5563db100fa4fcf080 Mon Sep 17 00:00:00 2001 From: Zac Echola Date: Thu, 25 Sep 2014 12:35:24 -0500 Subject: add some contributing text. --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29..53b2af1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +## Modifying the code +First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) 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](http://gruntjs.com/getting-started). + +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. 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. Push to your fork and submit a pull request. + +### Licensing +By contributing your code, you agree to license your contribution under [the MIT License](https://github.com/twbs/bootlint/blob/master/LICENSE). -- cgit v1.2.3