Added version release changes.

Updated gem dependencies.
Updated GitHub templates.
2017-07-16 16:13:10 -06:00 · 2017-07-10 20:55:04 -06:00 · 2017-06-28 20:26:57 -06:00 · 2017-06-25 06:45:26 -06:00 · 2017-06-24 11:58:03 -06:00 · 2017-06-18 16:05:53 -06:00
10 changed files with 103 additions and 53 deletions
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,16 +1,11 @@
-## Expected Behavior
-<!-- Required. Describe, in detail, the behavior experienced. -->
-
-## Actual Behavior
-<!-- Required. Describe, in detail, what should be the correct behavior. -->
+## Overview
+<!-- Required. Describe, in detail, the behavior experienced and what is desired. -->

 ## Steps to Recreate
-<!-- Required. List the exact steps to the reproduce errant behavior. -->
+<!-- Optional. List exact steps (numbered list) to reproduce errant behavior. Delete if unused. -->

-0.
+## Screenshots/Screencasts
+<!-- Optional. Attach screenshot/screencast(s) that demo the behavior. Delete if unused. -->

 ## Environment
 <!-- Optional. What is your operating system, software version(s), etc. Delete if unused. -->
-
-## Screenshots/Screencasts
-<!-- Optional. Attach screenshots/screencasts that demo the behavior. Delete if unused. -->
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,10 +2,10 @@
 <!-- Required. Why is this important/necessary? -->

 ## Details
-<!-- Optional. List the key features/highlights as bullet points. -->
+<!-- Optional. List the key features/highlights as bullet points. Delete if unused. -->

 ## Notes
 <!-- Optional. List additional notes/references as bullet points. Delete if unused. -->

 ## Screenshots/Screencasts
-<!-- Optional. Provide image/video support. Delete if unused. -->
+<!-- Optional. Provide supporting image/video. Delete if unused. -->
--- a/.ruby-version
+++ b/.ruby-version
@@ -0,0 +1 @@
+2.4.1
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,3 +1,11 @@
+# v2.2.0 (2017-07-16)
+
+- Added Git Cop support.
+- Updated CONTRIBUTING documentation.
+- Updated GitHub templates.
+- Updated README headers.
+- Updated gem dependencies.
+
 # v2.1.0 (2017-04-29)

 - Fixed Java SE Development Kit install.
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,27 +1,22 @@
-# Overview
+# Contributing

 Thanks for taking an interest in this open source project. Your support and involvement is greatly
-appreciated. The following details what you need to know in order to contribute.
+appreciated. The following sections detail what you need to know in order to contribute.

-# Requirements
-
-Read through the [Programming Style
-Guides](https://github.com/bkuhlmann/style_guides/tree/master/programming).
-
-# Contributing Code
+## Code

 0. Read the project README before starting.
-0. Fork the `master` branch of the repository.
-0. Ensure there are no setup, usage, and/or test issues (see README for details).
+0. Fork the `master` branch of this repository and clone the fork locally.
+0. Ensure there are no setup, usage, and/or test issues.
 0. Add tests for new functionality and ensure they pass.
-0. Submit a pull request and follow the instructions it provides.
+0. Submit a pull request, follow the instructions it provides, and ensure the build passes.

-# Submitting Issues
+## Issues

-0. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
-0. Follow the instructions provided within the GitHub issue template.
+0. Submit an issue via the GitHub Issues tab (assuming one does not
+   already exist) and follow the instructions it provides.

-# Feedback
+## Feedback

-Expect a response within one to three business days.
-Changes, alternatives, and/or improvements might be suggested upon review.
+- Expect a response within one to three business days.
+- Changes, alternatives, and/or improvements might be suggested upon review.
--- a/6
+++ b/6
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "git-cop", "~> 1.3"
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -0,0 +1,28 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    equatable (0.5.0)
+    git-cop (1.3.0)
+      pastel (~> 0.7)
+      refinements (~> 4.1)
+      runcom (~> 1.1)
+      thor (~> 0.19)
+    pastel (0.7.1)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
+    rake (12.0.0)
+    refinements (4.1.0)
+    runcom (1.1.0)
+      refinements (~> 4.1)
+    thor (0.19.4)
+    tty-color (0.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git-cop (~> 1.3)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   1.15.1
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
 # macOS

+[![Circle CI Status](https://circleci.com/gh/bkuhlmann/mac_os.svg?style=svg)](https://circleci.com/gh/bkuhlmann/mac_os)
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)

 Shell scripts for automated macOS machine setup.
@@ -19,24 +20,24 @@ the two projects are meant to be used:

 <!-- Tocer[start]: Auto-generated, don't remove. -->

-# Table of Contents
+## Table of Contents

- [Features](#features)
- [Screencast](#screencast)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
-  - [Customization](#customization)
- [Versioning](#versioning)
- [Code of Conduct](#code-of-conduct)
+  - [Features](#features)
+  - [Screencast](#screencast)
+  - [Requirements](#requirements)
+  - [Setup](#setup)
+  - [Usage](#usage)
+    - [Customization](#customization)
+  - [Versioning](#versioning)
+  - [Code of Conduct](#code-of-conduct)
 - [Contributions](#contributions)
- [License](#license)
- [History](#history)
- [Credits](#credits)
+  - [License](#license)
+  - [History](#history)
+  - [Credits](#credits)

 <!-- Tocer[finish]: Auto-generated, don't remove. -->

-# Features
+## Features

 - Provides a command line interface, written in Bash with no additional dependencies, for
  installation and management of a macOS machine.
@@ -55,16 +56,16 @@ the two projects are meant to be used:
 - Sets up and configures installed software for use.
 - Supports restoration of machine backups.

-# Screencast
+## Screencast

 [![asciicast](https://asciinema.org/a/88971.png)](https://asciinema.org/a/88971)

-# Requirements
+## Requirements

 0. [macOS Sierra](https://www.apple.com/macos) (with latest software updates applied)
 0. [Xcode](https://developer.apple.com/xcode) (with accepted license agreement)

-# Setup
+## Setup

 Open a terminal window and execute one of the following setup sequences depending on your version
 preference:
@@ -73,14 +74,14 @@ Current Version (stable):

    git clone https://github.com/bkuhlmann/mac_os.git
    cd mac_os
-    git checkout v2.1.0
+    git checkout v2.2.0

 Master Version (unstable):

    git clone https://github.com/bkuhlmann/mac_os.git
    cd mac_os

-# Usage
+## Usage

 Run the following script:

@@ -126,7 +127,7 @@ been loaded.
 It is recommended that the `mac_os` project directory not be deleted and kept on the local machine
 in order to manage installed software and benefit from future upgrades.

-## Customization
+### Customization

 All executable scripts can be found in the `bin` folder:

@@ -157,7 +158,7 @@ project is built upon the functions found in the `lib` folder. See the

  - `lib/settings.sh`: Defines global settings for software applications, extensions, etc.

-# Versioning
+## Versioning

 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:

@@ -165,7 +166,7 @@ Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 - Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
 - Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.

-# Code of Conduct
+## Code of Conduct

 Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
 participating in this project you agree to abide by its terms.
@@ -174,17 +175,17 @@ participating in this project you agree to abide by its terms.

 Read [CONTRIBUTING](CONTRIBUTING.md) for details.

-# License
+## License

 Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
 Read [LICENSE](LICENSE.md) for details.

-# History
+## History

 Read [CHANGES](CHANGES.md) for details.
 Built with [Bashsmith](https://github.com/bkuhlmann/bashsmith).

-# Credits
+## Credits

 Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
 [Alchemists](https://www.alchemists.io).
--- a/9
+++ b/9
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+begin
+  require "git/cop/rake/setup"
+rescue LoadError => error
+  puts error.message
+end
+
+task default: :git_cop
--- a/circle.yml
+++ b/circle.yml
@@ -0,0 +1,7 @@
+dependencies:
+  pre:
+    - gem update --system
+    - gem update bundler
+test:
+  override:
+    - bundle exec rake
Author	SHA1	Message	Date
Brooke Kuhlmann	cc23f2d634	Added version release changes.	2017-07-16 16:13:10 -06:00
Brooke Kuhlmann	4d85b3353f	Updated gem dependencies.	2017-07-10 20:55:04 -06:00
Brooke Kuhlmann	a757ed1210	Updated GitHub templates. - Simplified more of the process. - Reduced what is required/optional. - Clarified the help comments. [ci skip]	2017-06-28 20:26:57 -06:00
Brooke Kuhlmann	2994653972	Updated CONTRIBUTING documentation. - With code quality tools in place to automate most requirements, the documentation doesn't need to be as verbose. - The documentation has been reduced to the core essentials which means there is less to read and no more links to follow. [ci skip]	2017-06-25 06:45:26 -06:00
Brooke Kuhlmann	6716e687d1	Updated gem dependencies.	2017-06-24 11:58:03 -06:00
Brooke Kuhlmann	18dccd7773	Added Git Cop support. - Ensures Git commits are consistent. - [Details](https://github.com/bkuhlmann/git-cop).	2017-06-18 16:05:53 -06:00
Brooke Kuhlmann	88494e2ed3	Updated README headers. - Reserve H1's for project label and H2's for top-levels for the rest of the document. [ci skip]	2017-06-18 14:15:34 -06:00