lolcommits-term_output 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7611cd3a65922c390b7ac263411258f60687cf60b01dc8c54558bda51857f04c
-  data.tar.gz: 9e07314a55e7b099b64353e2a7d7fdbf7da11b30753b922aa53a1385e2bbf13b
+  metadata.gz: 82aa8dc2bb8de55071499b4b241a50b98738c909fe278b239cf59a9719e07cd3
+  data.tar.gz: c23977e0ed9d09239ee91b5adf0686af1e224b3a43fdb0f9cde981ecb6d04b40
 SHA512:
-  metadata.gz: '055786580484e7bd27f99e45811b8c2ad521908837c1ebe47bc2f5e0eb213126e6deca912d000778bfe1eaa3956add524bfe381e17294b3bbf3405d3c69b3d44'
-  data.tar.gz: 65764fc66ee33b82238a7ce0ced9a9b87eb0e1b5e92d7da77d5fcc7d630600f734a044abc841d5834b9f41d55bddcc29cd24f7a693b4b0d55c7cf0009a7e4aa3
+  metadata.gz: 25621b8daf7f8927106481aa5dd45c2a007057425d46437ea6fb6fc6992fac25c560a0c7972e909685b979a3815a99805ae5610b2b51fb8cfe7797a22bb9737c
+  data.tar.gz: 7092a9764256afd48cb2a909616587bcacc33ab35004d0f1587d38eb93060ec250ee9c5b02cc2fdc7535a7f553867a6279fc6e6f251a57b15b0cdbc4e4f97c0b

data/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  rubocop:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_ONLY: rubocop
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3.0
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rubocop --parallel
+  test:
+    name: ${{ format('Unit tests (Ruby {0})', matrix.ruby-version) }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - "3.4"
+    continue-on-error: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Configure Git
+        run: |
+          git config --global user.name $NAME
+          git config --global user.email $EMAIL
+        env:
+          NAME: "George Costanza"
+          EMAIL: "george.costanza@vandelay.com"
+      - name: Run tests
+        run: bundle exec rake test

data/.quickhook/pre-commit/ruby-lint

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -e
+grep -E "\.rb$|Rakefile|Gemfile" | xargs ./bin/rubocop --config .rubocop.yml --force-exclusion

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

data/CHANGELOG.md

@@ -9,7 +9,12 @@ project adheres to [Semantic Versioning][Semver].
 
 - Your contribution here!
 
-## [0.5.0] - 2024--09-24
+## [0.5.1] - 2024-12-29
+### Changed
+- Push gems with bundler (not GitHub actions)
+- Updated documentation links
+
+## [0.5.0] - 2024-09-24
 ### Removed
 - Support for Ruby < 3.1 (older rubies no longer supported)
 
@@ -68,7 +73,8 @@ project adheres to [Semantic Versioning][Semver].
 ### Changed
 - Initial release
 
-[Unreleased]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.2.0...v0.3.0
@@ -82,4 +88,3 @@ project adheres to [Semantic Versioning][Semver].
 [0.0.2]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.0.1...v0.0.2
 [0.0.1]: https://github.com/lolcommits/lolcommits-term_output/compare/0251ee8...v0.0.1
 [KeepAChangelog]: http://keepachangelog.com/en/1.0.0/
-[Semver]: http://semver.org/spec/v2.0.0.html

data/Gemfile

@@ -1,2 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
+
+group :rubocop do
+  gem "rubocop-rails-omakase", require: false
+end

data/README.md

@@ -1,17 +1,16 @@
 # Lolcommits Term Output
 
-[![Build](https://img.shields.io/github/actions/workflow/status/lolcommits/lolcommits-term_output/build.yml?branch=main&style=flat)](https://github.com/lolcommits/lolcommits-term_output/actions/workflows/build.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/lolcommits/lolcommits-term_output/ci.yml?branch=main&style=flat&label=CI)](https://github.com/lolcommits/lolcommits-term_output/actions/workflows/ci.yml)
 [![Gem](https://img.shields.io/gem/v/lolcommits-term_output.svg?style=flat)](http://rubygems.org/gems/lolcommits-term_output)
 [![Depfu](https://img.shields.io/depfu/lolcommits/lolcommits-term_output.svg?style=flat)](https://depfu.com/github/lolcommits/lolcommits-term_output)
 
-[lolcommits](https://lolcommits.github.io/) takes a snapshot with your
-webcam every time you git commit code, and archives a lolcat style image
-with it. Git blame has never been so much fun!
+[lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
+every time you git commit code, and archives a lolcat style image with it. Git
+blame has never been so much fun!
 
-This plugin uses the [inline
-image](http://iterm2.com/documentation-images.html) feature available in
-[iTerm2](http://iterm2.com/index.html) to display each lolcommit (images
-only) in your terminal (after committing). For example:
+This plugin uses the [inline image](http://iterm2.com/documentation-images.html)
+feature available in [iTerm2](http://iterm2.com/index.html) to display each
+lolcommit (images only) in your terminal (after committing). For example:
 
 ![iterm inline sample screenshot](./assets/images/sample.png)
 
@@ -34,20 +33,19 @@ Then configure to enable and set the remote endpoint:
     $ lolcommits --config -p term_output
     # set enabled to `true`
 
-That's it! Your next lolcommit will be displayed within your terminal.
-To disable use:
+That's it! Your next lolcommit will be displayed within your terminal.  To
+disable use:
 
     $ lolcommits --config -p term_output
     # and set enabled to `false`
 
 ## Development
 
-Check out this repo and run `bin/setup`, this will install all
-dependencies and generate docs. Use `bundle exec rake` to run all tests
-and generate a coverage report.
+Check out this repo and run `bin/setup`, this will install all dependencies and
+generate docs. Use `bundle exec rake` to run all tests.
 
-You can also run `bin/console` for an interactive prompt that will allow
-you to experiment with the gem code.
+You can also run `bin/console` for an interactive prompt that will allow you to
+experiment with the gem code.
 
 ## Tests
 
@@ -64,17 +62,14 @@ Generate docs for this gem with:
 ## Troubles?
 
 If you think something is broken or missing, please raise a new
-[issue](https://github.com/lolcommits/lolcommits-term_output/issues).
-Take a moment to check it hasn't been raised in the past (and possibly
-closed).
+[issue](https://github.com/lolcommits/lolcommits-term_output/issues).  Take a
+moment to check it hasn't been raised in the past (and possibly closed).
 
 ## Contributing
 
-Bug
-[reports](https://github.com/lolcommits/lolcommits-term_output/issues)
-and [pull
-requests](https://github.com/lolcommits/lolcommits-term_output/pulls)
-are welcome on GitHub.
+Bug [reports](https://github.com/lolcommits/lolcommits-term_output/issues) and
+[pull requests](https://github.com/lolcommits/lolcommits-term_output/pulls) are
+welcome on GitHub.
 
 When submitting pull requests, remember to add tests covering any new behaviour,
 and ensure all tests are passing on CI. Read the [contributing
@@ -94,8 +89,8 @@ The gem is available as open source under the terms of
 
 ## Links
 
-* [CI](https://github.com/lolcommits/lolcommits-term_output/actions/workflows/build.yml)
-* [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-term_output)
+* [CI](https://github.com/lolcommits/lolcommits-term_output/actions/workflows/ci.yml)
+* [RDoc](https://rubydoc.info/gems/lolcommits-term_output)
 * [Issues](http://github.com/lolcommits/lolcommits-term_output/issues)
 * [Report a bug](http://github.com/lolcommits/lolcommits-term_output/issues/new)
 * [Gem](http://rubygems.org/gems/lolcommits-term_output)

data/Rakefile

@@ -18,4 +18,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => ['test']
+task default: [ "test" ]

data/bin/rubocop

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+load Gem.bin_path("rubocop", "rubocop")

data/lib/lolcommits/plugin/term_output.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
-require 'base64'
-require 'lolcommits/plugin/base'
+require "base64"
+require "lolcommits/plugin/base"
 
 module Lolcommits
   module Plugin
     class TermOutput < Base
-
       ## Prompts the user to configure the plugin's options. The default
-      #superclass method will ask for the `enabled` option to be set.
+      # superclass method will ask for the `enabled` option to be set.
       #
       # @return [Hash] hash of configured options `{ enabled: true/false }`
       # @return [Nil] if this terminal does not support this plugin
@@ -33,16 +32,16 @@ module Lolcommits
       def run_capture_ready
         if terminal_supported?
           if !runner.vcs_info || runner.vcs_info.repo.empty?
-            debug 'repo is empty, skipping term output'
+            debug "repo is empty, skipping term output"
           elsif !image_path
-            debug 'lolcommit videos not supported'
+            debug "lolcommit videos not supported"
           else
             debug "rendering image in iTerm"
             base64 = Base64.encode64(open(image_path, &:read).to_s)
             puts "#{begin_escape}1337;File=inline=1:#{base64};alt=#{runner.message};#{end_escape}\n"
           end
         else
-          debug 'Terminal not supported (requires iTerm2)'
+          debug "Terminal not supported (requires iTerm2)"
         end
       end
 
@@ -89,7 +88,7 @@ module Lolcommits
       # @return [Boolan] true when running within a Tmux session
       #
       def tmux?
-        !ENV['TMUX'].nil?
+        !ENV["TMUX"].nil?
       end
 
       ##
@@ -98,7 +97,7 @@ module Lolcommits
       # @return [Boolan] true when terminal identifies as iTerm
       #
       def terminal_supported?
-        ENV['TERM_PROGRAM'] =~ /iTerm/
+        ENV["TERM_PROGRAM"] =~ /iTerm/
       end
     end
   end

data/lib/lolcommits/term_output/version.rb

@@ -2,6 +2,6 @@
 
 module Lolcommits
   module TermOutput
-    VERSION = "0.5.0".freeze
+    VERSION = "0.5.1".freeze
   end
 end

data/lib/lolcommits/term_output.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require 'lolcommits/term_output/version'
-require 'lolcommits/plugin/term_output'
+require "lolcommits/term_output/version"
+require "lolcommits/plugin/term_output"

data/lolcommits-term_output.gemspec

@@ -5,8 +5,8 @@ require 'lolcommits/term_output/version'
 Gem::Specification.new do |spec|
   spec.name        = "lolcommits-term_output"
   spec.version     = Lolcommits::TermOutput::VERSION
-  spec.authors     = ["Matthew Hutchinson"]
-  spec.email       = ["matt@hiddenloop.com"]
+  spec.authors     = [ "Matthew Hutchinson" ]
+  spec.email       = [ "matt@hiddenloop.com" ]
   spec.summary     = "Display lolcommits within your iTerm terminal"
   spec.homepage    = "https://github.com/lolcommits/lolcommits-term_output"
   spec.license     = "LGPL-3.0"
@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata = {
     "homepage_uri"      => "https://github.com/lolcommits/lolcommits-term_output",
+    "documentation_uri" => "https://rubydoc.info/gems/lolcommits-term_output",
     "changelog_uri"     => "https://github.com/lolcommits/lolcommits-term_output/blob/master/CHANGELOG.md",
     "source_code_uri"   => "https://github.com/lolcommits/lolcommits-term_output",
     "bug_tracker_uri"   => "https://github.com/lolcommits/lolcommits-term_output/issues",
@@ -24,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {test,features}/*`.split("\n")
   spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ "lib" ]
 
   spec.required_ruby_version = ">= 3.1"
 

data/test/lolcommits/plugin/term_output_test.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Lolcommits::Plugin::TermOutput do
+  include Lolcommits::TestHelpers::GitRepo
+  include Lolcommits::TestHelpers::FakeIO
+
+  # initialize and reset env vars before tests run
+  before do
+    @old_tmux = ENV["TMUX"]
+    @old_term_program = ENV["TERM_PROGRAM"]
+    ENV["TERM_PROGRAM"] = "iTerm"
+    ENV["TMUX"] = nil
+  end
+
+  after do
+    ENV["TERM_PROGRAM"] = @old_term_program
+    ENV["TMUX"] = @old_tmux
+  end
+
+  describe "with a runner" do
+    def runner
+      # a simple lolcommits runner with an empty configuration Hash
+      @runner ||= Lolcommits::Runner.new.tap do |r|
+        r.lolcommit_path = lolcommit_path
+      end
+    end
+
+    def lolcommit_path
+      File.expand_path(File.dirname(__FILE__) + "../../../assets/test_image.jpg")
+    end
+
+    def plugin
+      @plugin ||= Lolcommits::Plugin::TermOutput.new(runner: runner)
+    end
+
+    def valid_enabled_config
+      { enabled: true }
+    end
+
+    describe "#enabled?" do
+      it "is false by default" do
+        _(plugin.enabled?).must_equal false
+      end
+
+      it "is true when configured" do
+        plugin.configuration = valid_enabled_config
+        _(plugin.enabled?).must_equal true
+      end
+    end
+
+    describe "run_capture_ready" do
+      before { commit_repo_with_message("test commit") }
+      after { teardown_repo }
+
+      def check_plugin_output(matching_regex)
+        in_repo do
+          plugin.configuration = valid_enabled_config
+          output = fake_io_capture { plugin.run_capture_ready }
+          _(output).must_match matching_regex
+        end
+      end
+
+      it "outputs lolcommits image inline to terminal" do
+        check_plugin_output(/^\e\]1337;File=inline=1\:.+\n;alt=test commit;\a\n$/m)
+      end
+
+      describe "when running in a Tmux session" do
+        before do
+          ENV["TMUX"] = "true"
+        end
+
+        it "outputs lolcommits image inline to terminal with Tmux escape sequence" do
+          check_plugin_output(/^\ePtmux;\e\e\]1337;File=inline=1\:.+\n;alt=test commit;\a\e\\\n$/m)
+        end
+      end
+
+      describe "when using an unsupported terminal" do
+        before do
+          ENV["TERM_PROGRAM"] = "konsole"
+        end
+
+        it "outputs nothing to the terminal" do
+          check_plugin_output ""
+        end
+      end
+    end
+
+    describe "configuration" do
+      it "allows plugin options to be configured" do
+        inputs = %w[ true ]  # enabled option
+        configured_plugin_options = {}
+
+        fake_io_capture(inputs: inputs) do
+          configured_plugin_options = plugin.configure_options!
+        end
+
+        _(configured_plugin_options).must_equal({ enabled: true })
+      end
+
+      describe "when terminal not supported" do
+        before do
+          ENV["TERM_PROGRAM"] = "konsole"
+        end
+
+        it "does not allow options to be configured" do
+          inputs = %w[ true ]  # enabled option
+          configured_plugin_options = {}
+
+          output = fake_io_capture(inputs: inputs) do
+            configured_plugin_options = plugin.configure_options!
+          end
+
+          assert_equal configured_plugin_options, {}
+          _(output).must_match(/Sorry, this terminal does not support this plugin/)
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+# lolcommits gem
+require "lolcommits"
+
+# lolcommit test helpers
+require "lolcommits/test_helpers/git_repo"
+require "lolcommits/test_helpers/fake_io"
+
+# plugin gem test libs
+require "lolcommits/term_output"
+require "minitest/autorun"
+
+# swallow all debug output during test runs
+def debug(msg); end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-term_output
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Matthew Hutchinson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lolcommits
@@ -73,35 +73,38 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".github/workflows/push_gem.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".simplecov"
-- ".travis.yml"
+- ".quickhook/pre-commit/ruby-lint"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
-- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
 - bin/console
+- bin/rubocop
 - bin/setup
 - lib/lolcommits/plugin/term_output.rb
 - lib/lolcommits/term_output.rb
 - lib/lolcommits/term_output/version.rb
 - lolcommits-term_output.gemspec
+- test/assets/test_image.jpg
+- test/lolcommits/plugin/term_output_test.rb
+- test/test_helper.rb
 homepage: https://github.com/lolcommits/lolcommits-term_output
 licenses:
 - LGPL-3.0
 metadata:
   homepage_uri: https://github.com/lolcommits/lolcommits-term_output
+  documentation_uri: https://rubydoc.info/gems/lolcommits-term_output
   changelog_uri: https://github.com/lolcommits/lolcommits-term_output/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/lolcommits/lolcommits-term_output
   bug_tracker_uri: https://github.com/lolcommits/lolcommits-term_output/issues
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +119,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Display lolcommits within your iTerm terminal
-test_files: []
+test_files:
+- test/assets/test_image.jpg
+- test/lolcommits/plugin/term_output_test.rb
+- test/test_helper.rb

data/.github/workflows/build.yml

@@ -1,34 +0,0 @@
-name: Tests
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: ['3.1', '3.2', '3.3', '3.4']
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Configure git user name, email
-      run: |
-        git config --global user.name $NAME
-        git config --global user.email $EMAIL
-      env:
-        NAME: "George Costanza"
-        EMAIL: "george.costanza@vandelay.com"
-    - name: Run tests
-      run: bundle exec rake test

data/.github/workflows/push_gem.yml

@@ -1,25 +0,0 @@
-name: Publish gem to RubyGems.org
-
-on:
-  push:
-    tags:
-      - v*
-
-jobs:
-  push:
-    name: Push gem to RubyGems.org
-    runs-on: ubuntu-latest
-
-    permissions:
-      id-token: write
-      contents: write
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: ruby
-
-      - uses: rubygems/release-gem@v1

data/.simplecov

@@ -1,9 +0,0 @@
-SimpleCov.start do
-  add_filter '/test/'
-  add_filter '/vendor/'
-end
-
-SimpleCov.at_exit do
-  SimpleCov.result.format!
-  `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
-end

data/.travis.yml

@@ -1,29 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-  - 3.0.0
-  - ruby-head
-
-before_install:
-  - git --version
-  - git config --global user.email "lol@commits.org"
-  - git config --global user.name "Lolcommits"
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-
-env:
-  global:
-    - CC_TEST_REPORTER_ID=eb8c60bf77e0ed78453285e1d9c0aa4c9c248a4945f077615edb042db7753fb9
-    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +0,0 @@
-
-Explain what you're changing and why here.
-
----
-#### :memo: Checklist
-
-Please check this list and leave it intact for the reviewer. Thanks! :heart:
-
-- [ ] Commit messages provide context (why not just what, some tips [here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)).
-- [ ] If relevant, mention GitHub issue number above and include in a commit message.
-- [ ] Latest code from master merged.
-- [ ] New behaviour has test coverage.
-- [ ] Avoid duplicating code.
-- [ ] No commented out code.
-- [ ] Avoid comments for your code, write code that explains itself.
-- [ ] Changes are simple, useful, clear and brief.