Merge pull request #6 from chef/cleanup

Sync boilerplate with other gems

10 files changed, 103 insertions, 33 deletions

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..fee8d42
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1,4 @@
+# Order is important. The last matching pattern has the most precedence.
+
+*               @chef/client-maintainers
+.expeditor/**   @chef/jex-team
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..90c720d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,12 @@
+## Description
+<!--- Briefly describe the issue -->
+
+## Gem Version
+<!--- Tell us which version of the gem you are using. -->
+
+## Windows Version
+<!--- Tell us which version of Windows you are running. -->
+
+## Replication Case
+<!--- Tell us what steps to take to replicate your problem.  See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve)
+for information on how to create a good replication case. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..29bf60c
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,14 @@
+### Description
+
+[Please describe what this change achieves]
+
+### Issues Resolved
+
+[List any existing issues this PR resolves, or any Discourse or
+StackOverflow discussions that are relevant]
+
+### Check List
+
+- [ ] New functionality includes tests
+- [ ] All tests pass
+- [ ] All commits have been signed-off for the Developer Certificate of Origin. See <https://github.com/chef/chef/blob/master/CONTRIBUTING.md#developer-certification-of-origin-dco>
diff --git a/.travis.yml b/.travis.yml
index de8b4fa..cab23f0 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,12 +1,20 @@
+sudo: false
 language: ruby
 cache: bundler
-sudo: false
 
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+matrix:
+  include:
+    - rvm: 2.3.7
+    - rvm: 2.4.4
+    - rvm: 2.5.3
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: ruby-head
+
+branches:
+  only:
+    - master
 
-bundler_args: --jobs 7
+bundler_args: --jobs 7 --without docs debug
 
 script: bundle exec rspec --color --format progress
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1651ff8..672042b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,10 +1,6 @@
 # WMI-Lite  Change Log
 
-## Unreleased
-* Initial implementation
-
-Last Release: v1.0.0 (2014-05-15)
--------------------
+## [v1.0.0](https://github.com/chef/wmi-lite/tree/v1.0.0) (2014-05-15)
 - First public release
 
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index 0849724..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Contributing to WMI-Lite
-
-We are glad you want to contribute to WMI-Lite. Please see contribution guidelines for
-[Chef](https://docs.chef.io/community_contributions.html) for information on contributing to this project.
-
diff --git a/Gemfile b/Gemfile
index 851fabc..3f0c104 100644
--- a/Gemfile
+++ b/Gemfile
@@ -1,2 +1,21 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
 gemspec
+
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+end
+
+group :debug do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+end
+
+instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")
diff --git a/README.md b/README.md
index 0c9118f..4191a30 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-Wmi-Lite
-========
+# Wmi-Lite
 
 [![Build Status](https://travis-ci.org/chef/wmi-lite.svg?branch=master)](https://travis-ci.org/chef/wmi-lite)
 [![Gem Version](https://badge.fury.io/rb/wmi-lite.svg)](https://badge.fury.io/rb/wmi-lite)
@@ -9,15 +8,14 @@ Wmi-Lite
 functionality on Windows. It has no dependencies outside of the Ruby interpreter
 and libraries and of course the Windows operating system.
 
-Installation
-------------
+## Installation
 
 To install it, run:
 
     gem install wmi-lite
 
-Usage
------
+## Usage
+
 To use `wmi-lite` in your Ruby source code, just `require` it:
 
 ```ruby
@@ -93,13 +91,25 @@ end
 puts
 ```
 
-License & Authors
------------------
 
-Author:: Adam Edwards (<adamed@chef.io>)
-Copyright:: Copyright (c) 2014-2015 Chef Software, Inc.
-License:: Apache License, Version 2.0
+## Development Documentation
+
+All documentation is written using YARD. You can generate a by running:
+
+```
+rake docs
+```
+
+## Contributing
 
+For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md)
+
+## License & Copyright
+
+- Copyright:: Copyright (c) 2014-2018 Chef Software, Inc.
+- License:: Apache License, Version 2.0
+
+```text
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
@@ -111,4 +121,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-
+```
diff --git a/Rakefile b/Rakefile
index c702cfc..c71976d 100644
--- a/Rakefile
+++ b/Rakefile
@@ -1 +1,15 @@
 require 'bundler/gem_tasks'
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new(:docs)
+rescue LoadError
+  puts "yard is not available. bundle install first to make sure all dependencies are installed."
+end
+
+task :console do
+  require "irb"
+  require "irb/completion"
+  ARGV.clear
+  IRB.start
+end
diff --git a/wmi-lite.gemspec b/wmi-lite.gemspec
index 3d2482f..7c473c7 100644
--- a/wmi-lite.gemspec
+++ b/wmi-lite.gemspec
@@ -15,8 +15,8 @@ Gem::Specification.new do |spec|
                        'without concerns around dependency issues.'
   spec.summary       = 'A lightweight utility library for accessing basic WMI '     \
                        '(Windows Management Instrumentation) functionality on Windows'
-  spec.homepage      = 'https://github.com/opscode/wmi-lite'
-  spec.license       = 'Apache 2.0'
+  spec.homepage      = 'https://github.com/chef/wmi-lite'
+  spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -26,6 +26,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'pry-byebug'
 end