diff options
author | Tim Smith <tsmith@chef.io> | 2019-04-13 09:33:35 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-04-13 09:33:35 -0700 |
commit | ae491457323f440b08eef7aced3d28e1362e195e (patch) | |
tree | a589ce91b99400822be13678cfac0627b8cba072 | |
parent | 7582a96b976bfb529c3c05f1a7bbc867f2d316f0 (diff) | |
parent | d3066d46bb769313d7d3542ea693ad0c9f6ef6a0 (diff) | |
download | ohai-ae491457323f440b08eef7aced3d28e1362e195e.tar.gz |
Merge pull request #1351 from burtlo/README-add_style
Adds mention of the style task
-rw-r--r-- | README.md | 24 |
1 files changed, 23 insertions, 1 deletions
@@ -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 |