Add new docs

sensu · Dec 22, 2014 · 40ebd94 · 40ebd94
1 parent 3bfe277
commit 40ebd94
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 10 deletions.
diff --git a/CHANGELOG → CHANGELOG.md b/CHANGELOG → CHANGELOG.md
diff --git a/CONTRIB.md → CONTRIBUTING.md b/CONTRIB.md → CONTRIBUTING.md
@@ -95,25 +95,32 @@ Rubocop is used to lint the style of the ruby plugins. This is done
 to standardize the style used within these plugins, and ensure high
 quality code.  All current rules with the exception of <b>Style/FileName</b> are currently in effect.
 
-You can test rubocop conpliance for yourself by installing the gem and running <i>rubocop</i> from the command line.
+You can test rubocop compliance for yourself by installing the gem and running <i>rubocop</i> from the command line.
 Running <i>rubocop -a</i> will attempt to autocorrect any issues, saving yourself considerable time in large files.
 
 If it truely makes sense for your code to violate a rule you can disable that rule with your code by either using
-```shell
-# rubocop:disable <rule>, <rule>
-``` 
+
+    # rubocop:disable <rule>, <rule>
+
+
 at the end of the line in violation or
-```shell
-rubocop:disable <rule>, <rule>
-<code block>
-rubocop:enable <rule>, <rule>
-```
 
-If you use either of these methods please mention in the PR as this should be kept to an absolute minium at times, especially concerning method length and complexity, it makes sense to use on of the above methods.
+    rubocop:disable <rule>, <rule>
+    <code block>
+    rubocop:enable <rule>, <rule>
+
+If you use either of these methods please mention in the PR as this should be kept to an absolute minimum at times, especially concerning method length and complexity, it makes sense to use on of the above methods.
 
 ### Rspec
 
 Currently we have RSpec as a [test framework](https://github.com/sensu/sensu-plugin-spec). Please add coverage for your check.  Checks will not be considered production grade and stable until they have complete coverage.
+
+You can use the included Vagrantfile for easy testing.  All necessary version of Ruby can be installed with their own dedicated gem sets using RVM.  Just boot up the machine and drop into /vagrant and execute
+
+    rake default
+
+to run all specs and rubocop tests.
+
 This is ~~little bit hard~~ almost impossible for non-ruby checks. Let someone from [team](https://github.com/sensu?tab=members) know and maybe can can help.
 
 ### Issue and PR Tracking