summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLynn Frank <franklin.webber@gmail.com>2019-04-13 09:20:30 -0500
committerLynn Frank <franklin.webber@gmail.com>2019-04-13 09:20:30 -0500
commite46a1236182634e0430ced1cb867c4ace26aebc4 (patch)
tree599e3006f8e0555a5c8605cca5ac7591b1a6a8c1
parent05e507952d8dbff8e31528f1ebcab72664e99aa2 (diff)
downloadohai-e46a1236182634e0430ced1cb867c4ace26aebc4.tar.gz
Adds mention of the style task
Add some mention of the style task Update the `rake -T` to include `bundle exec` Signed-off-by: Franklin Webber <franklin.webber@gmail.com>
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index fdff54c3..cf939e9c 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