Added version release notes

Updated README screencast cover to SVG format
Replaces PNG in favor of SVG for faster loading and smaller memory footprint.
2020-07-22 20:15:48 -06:00 · 2020-07-16 19:15:37 -06:00 · 2020-06-20 08:18:46 -06:00 · 2020-06-18 07:14:35 -06:00 · 2020-06-13 15:47:00 -06:00 · 2020-06-13 09:24:27 -06:00
6 changed files with 45 additions and 35 deletions
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,11 +1,14 @@
 ## Overview
-<!-- Required. Describe, in detail, the behavior experienced and what is desired. -->
+<!-- Required. Describe, briefly, the behavior experienced. -->
 ## Steps to Recreate
 <!-- Optional. List exact steps (numbered list) to reproduce errant behavior. Delete if unused. -->
 ## Screenshots/Screencasts
-<!-- Optional. Attach screenshot/screencast(s) that demo the behavior. Delete if unused. -->
+<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
 ## Steps to Recreate
 <!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
 ## Desired Behavior
 <!-- Required. Describe the behavior you'd like to see or your idea of a proposed solution. -->
 ## Environment
-<!-- Optional. What is your operating system, software version(s), etc. Delete if unused. -->
+<!-- Required. What is your operating system, software version(s), etc. -->
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,11 +1,11 @@
 ## Overview
-<!-- Required. Why is this important/necessary? -->
+<!-- Required. Why is this important/necessary and what is the overarching architecture. -->
 ## Details
 <!-- 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 supporting image/video. Delete if unused. -->
+<!-- Optional. Provide supporting image/video. -->
 ## Details
 <!-- Optional. List the key features/highlights as bullet points. -->
 ## Notes
 <!-- Optional. List additional notes/references as bullet points. -->
--- a/CHANGES.adoc
+++ b/CHANGES.adoc
@@ -1,15 +1,26 @@
 = Changes
 == 8.2.0 (2020-07-22)
 * Fixed project requirements
 * Fixed screencast image URL
 * Updated GitHub templates
 * Updated README credit URL
 * Updated README screencast URL
 * Updated README screencast cover to SVG format
 * Updated to Git Lint 1.0.0
 * Refactored Rakefile requirements
 == 8.1.0 (2020-04-01)
- Added README production and development setup instructions
+* Added README production and development setup instructions
- Updated Circle CI build label
+* Updated Circle CI build label
- Updated README screencast to use larger image
+* Updated README screencast to use larger image
- Updated documentation to ASCII Doc format
+* Updated documentation to ASCII Doc format
- Updated to Code of Conduct 2.0.0
+* Updated to Code of Conduct 2.0.0
- Updated to Git Cop 4.0.0
+* Updated to Git Cop 4.0.0
- Updated to Ruby 2.7.1
+* Updated to Ruby 2.7.1
- Removed README images
+* Removed README images
 == 8.0.1 (2020-01-01)
--- a/2
+++ b/2
@@ -3,4 +3,4 @@
 source "https://rubygems.org"
 gem "rake", "~> 13.0"
-gem "git-cop", "~> 4.0"
+gem "git-lint", "~> 1.0"
--- a/README.adoc
+++ b/README.adoc
@@ -41,13 +41,13 @@ toc::[]
 == Screencast
-[link=https://www.alchemists.io/screencasts/mac_o_s.html]
+[link=https://www.alchemists.io/screencasts/mac_os]
-image::https://www.alchemists.io/images/screencasts/mac_o_s/cover-original.png[Screencast,role=focal_point]
+image::https://www.alchemists.io/images/screencasts/mac_os/cover.svg[Screencast,600,240,role=focal_point]
 == Requirements
-. https://www.apple.com/macos/catalina[macOS Catalina] (with latest software updates applied)
+. link:https://www.apple.com/macos/catalina[macOS]
-. https://developer.apple.com/xcode[Xcode] (with accepted license agreement)
+. link:https://developer.apple.com/xcode[Xcode]
 == Setup
@@ -59,7 +59,7 @@ To install, run:
 ----
 git clone https://github.com/bkuhlmann/mac_os.git
 cd mac_os
-git checkout 8.1.0
+git checkout 8.2.0
 ----
 === Development
@@ -248,4 +248,4 @@ Read link:CHANGES.adoc[CHANGES] for details.
 == Credits
-Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann.html[Brooke Kuhlmann].
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
--- a/8
+++ b/8
@@ -1,9 +1,5 @@
 # frozen_string_literal: true
-begin
+require "git/lint/rake/setup"
  require "git/cop/rake/setup"
 rescue LoadError => error
  puts error.message
 end
-task default: :git_cop
+task default: :git_lint
Author	SHA1	Message	Date
Brooke Kuhlmann	09025fd976	Added version release notes	2020-07-22 20:15:48 -06:00
Brooke Kuhlmann	a97de70b65	Updated README screencast cover to SVG format Replaces PNG in favor of SVG for faster loading and smaller memory footprint.	2020-07-16 19:15:37 -06:00
Brooke Kuhlmann	1d75357a18	Fixed project requirements Links were updated and version information was dropped in order to specify the bare minimum requirements and reduce situations where the documentation might not always be up-to-date with the exact version being used.	2020-06-20 08:18:46 -06:00
Brooke Kuhlmann	3c78a1cbf0	Refactored Rakefile requirements Turns out the rescue block wasn't providing a lot of additional aid as the Bundler and Rake errors are sufficient. By removing this block, the error output remains clear and improves readability.	2020-06-18 07:14:35 -06:00
Brooke Kuhlmann	3158d024df	Updated to Git Lint 1.0.0 It is necessary to drop Git Cop because it has been deprecated. [Git Lint](https://www.alchemists.io/projects/git-lint) is the new offical gem for analyzing Git commit quality.	2020-06-13 15:47:00 -06:00
Brooke Kuhlmann	62295d0851	Updated GitHub templates Provides more clarity on the format desired when opening up an issue or a pull request. The order of sections was rearranged to focus on the why and what of the root issue. Optional sections remain encouraged but are not required.	2020-06-13 09:24:27 -06:00
Brooke Kuhlmann	34f7dad25d	Fixed screencast image URL The URL was being built incorrectly originally but is now fixed.	2020-04-04 15:09:07 -06:00
Brooke Kuhlmann	e8101bbb3b	Updated README screencast URL Necessary to point to new URL which doesn't force the HTML format (will provide more flexibility in the future).	2020-04-03 11:40:07 -06:00
Brooke Kuhlmann	3f9eaf969d	Updated README credit URL Necessary to pick up new author profile URL.	2020-04-03 11:32:44 -06:00