Merge pull request #1351 from burtlo/README-add_style

Adds mention of the style task

1 files changed, 23 insertions, 1 deletions

diff --git a/README.md b/README.md
index fdff54c3..2156b8a8 100644
--- a/README.md
+++ b/README.md
@@ -31,12 +31,26 @@ You can run individual test files by running the rspec executable:
 bundle exec rspec spec/unit/FILE.rb
 ```
 
+## Style:
+
+We use [Chefstyle](https://github.com/chef/chefstyle), as a code [linter](https://en.wikipedia.org/wiki/Lint_(software)), to enforce style guidelines. To run:
+
+```
+bundle exec rake style
+```
+
+You can run and automatically correct the issues:
+
+```
+bundle exec rake style:auto_correct
+```
+
 ## Rake Tasks
 
 Ohai has some Rake tasks for doing various things.
 
 ```
-rake -T
+bundle exec rake -T
 rake build               # Build ohai-$VERSION.gem into the pkg directory
 rake clean               # Remove any temporary products
 rake clobber             # Remove any generated files
@@ -65,6 +79,14 @@ Issues:
 
 For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
 
+1. Fork it
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Run the tests `bundle exec rake spec`
+1. Run the style tests `bundle exec rake style`
+1. Push to the branch (git push origin my-new-feature)
+1. Create new Pull Request
+
 ## License
 
 Ohai - system information application