diff --git a/CHANGELOG b/CHANGELOG.md similarity index 100% rename from CHANGELOG rename to CHANGELOG.md diff --git a/CONTRIB.md b/CONTRIBUTING.md similarity index 90% rename from CONTRIB.md rename to CONTRIBUTING.md index 5f6f959aa..c3c9ffa65 100644 --- a/CONTRIB.md +++ b/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 Style/FileName are currently in effect. -You can test rubocop conpliance for yourself by installing the gem and running rubocop from the command line. +You can test rubocop compliance for yourself by installing the gem and running rubocop from the command line. Running rubocop -a 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 , -``` + + # rubocop:disable , + + at the end of the line in violation or -```shell -rubocop:disable , - -rubocop:enable , -``` -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 , + + rubocop:enable , + +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