way_of_working 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8af659ec8270a7df5b2333d631565faf9c7aa836be80dcfe704981d2d8f7336
-  data.tar.gz: 3490bf4f4ee2735b710a555edc6a8759c8390227c2c8a6ea8b5395a54dfd9122
+  metadata.gz: fcf87e5f8b8338ec91dc10bb579a9c8e9fa3e977745ba61cf8ae106cfb27201c
+  data.tar.gz: 3be69c82e3d055cefe8353bf440f085eb84f420427a131dbb4a5f888f12d67f6
 SHA512:
-  metadata.gz: d6cd047c825b78be49b8460c98d65da9259d014aa2888767705c6601190d6630e9c0446e255abb67b903ac5201196b27a218b2f514889fb2eef33b78aad66773
-  data.tar.gz: 631e4b3b9c62bd4c8daeaddc8617ddb3454ed2b33ddf08c29dc1219a8efd0a3b4948f9c36141bc579ee1c96be74d4a7671c7cced635004c53cffec3c02f476b4
+  metadata.gz: 70c5587a836fd9d530647f01e96fd725ac91ac418415e0d002613da943dfc502d6460d454bf81e9ea2c5f05ccfd78ef94b2b75adf8ca16261fa28c327c490a22
+  data.tar.gz: feb65211f0f6c7904c00a16dccdb1b8dde8de7ca3880282d7fe926543dae1de30fed6a1e722843f5bbcfb4dd2735b87dd0c5c6c4b9c9cbb72bf03a0a5a220a02

data/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added a panel for README badges and a Way of Working badge
+- Added a plugin system for new functionality
+
+### Removed
+
+- Moved MADR Decision Records to a separate plugin
+- Moved Contributor Covenant Code of Conduct to a separate plugin
+- Moved MegaLinter to a separate plugin
+- Moved Keep a Changelog to a separate plugin
+- Removed GitHub Pages
+
+### Security
+
+- Addressed known dependabot vulnerabilities
+
+### Fixed
+
+- A Changelog can now be created in project that hasn't been initialised as a git repository
+- Fixed the way active_support is used in this (non-rails) project
+
 ## [1.0.0] - 2023-02-17
 
 ### Added

data/CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
-
+<!--alex disable sex sexual-->
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -23,7 +23,7 @@ community include:
 * Giving and gracefully accepting constructive feedback
 * Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
+* Focusing on what is best not only for us as individuals, but for the overall
   community
 
 Examples of unacceptable behavior include:

data/README.md

@@ -1,90 +1,78 @@
-# HDI Engineering Way of Working
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+# Way of Working
+
+<!-- Way of Working: Main Badge Holder Start -->
+![Way of Working Badge](https://img.shields.io/badge/Way_of_Working-v2.0.0-%238169e3?labelColor=black)
+<!-- Way of Working: Additional Badge Holder Start -->
+<!-- Way of Working: Badge Holder End -->
+
+[![Gem Version](https://badge.fury.io/rb/way_of_working.svg)](https://badge.fury.io/rb/way_of_working)
+<br />
 [![MegaLinter](https://github.com/HealthDataInsight/way_of_working/workflows/MegaLinter/badge.svg?branch=main)](https://github.com/HealthDataInsight/way_of_working/actions?query=workflow%3AMegaLinter+branch%3Amain)
-[![Keep a Changelog v1.1.0 badge][changelog-badge]][changelog]
+[![Inclusive Language](https://github.com/HealthDataInsight/way_of_working/actions/workflows/inclusive-language.yml/badge.svg)](https://github.com/HealthDataInsight/way_of_working/actions/workflows/inclusive-language.yml)
 
 ## Introduction
 
-This framework will describe a consistent, high-quality approach to Software Engineering at HDI.
+This tool underpins the Way of Working framework, used to describe a consistent, high-quality approach to Software Engineering. It is intended as an opinionated approach supporting rapid development, across numerous projects, by a fungible workforce who can swap between assignments with the minimum friction.
 
-It is an opinionated approach intending to support rapid development, across numerous projects, by a fungible workforce who can swap between assignments with the minimum friction.
+It consists command line tool that uses a modular, plugin-based system to gain functionality, allowing for organisations to pick and choose different solutions for the same feature.
+Organisations can create their own gem which defines the specific plugin dependencies which form their way of working. See the [Way of Working for HDI](https://github.com/HealthDataInsight/way_of_working-for-hdi) as an example.
 
-It builds on the [twelve-factor app](https://12factor.net) methodology and is intended to be compatible with the [NHS Digital Software Engineering Quality Framework](https://github.com/NHSDigital/software-engineering-quality-framework) and other frameworks like [the GDS Way](https://gds-way.cloudapps.digital).
+There are subcommands that plugins hook into which enable them to add GitHub actions, configuration and other files to a project and GitHub pages outlining the tooling choice and thinking behind it.
 
-The most significant difference here is that we will be opinionated and make technological and process choices. Of course, users are encouraged to discuss and submit Pull Requests (PRs) if they want changes to the choices made, but by making those choices, we can automate many tedious background tasks that are currently manual.
+Below is a list of plugins that have been implemented so far:
 
-## Installation
+| Feature               | Plugin                                 | Description                                                                    |
+| --------------------- | -------------------------------------- | ------------------------------------------------------------------------------ |
+| Changelog             | [changelog-keepachangelog]             | Implements [keepachangelog v1.1]                                               |
+| Code Linting          | [code_linting-hdi]                     | Implements a combination of [MegaLinter] and [RuboCop] built on NDRS standards |
+| Code of Conduct       | [code_of_conduct-contributor_covenant] | Implements [Contributor Covenant v2.1]                                         |
+| Decision Records      | [decision_record-madr]                 | Implements [MADR v3]                                                           |
+| Inclusive Language    | [inclusive_language-alex]              | Implements [alex]                                                              |
+| Pull Request Template | [pull_request_template-hdi]            | Implements a bespoke PR template                                               |
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+bundle add way_of_working
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+gem install way_of_working
+```
 
 ## Usage
 
-### Changelog
-
-To add a [keep a changelog v1.1.0](https://keepachangelog.com/en/1.1.0/) changelog to your project, use the following at the command line:
-
-    way_of_working init changelog
-
-### Code Of Conduct
-
-To add a [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1 to your project, use the following at the command line:
-
-    way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
-
-You will need to enter a contact method, usually an email address. Please thoroughly read the [enforcement guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines) section of the code and discuss the implications of adopting the code of conduct.
-
-### Decision Records
-
-To add the [Markdown Any Decision Records (MADR)](https://adr.github.io/madr/) v3.0.0 framework to your project, run the following at the command line:
-
-    way_of_working init decision_record
-
-To create a new decision record, run:
-
-    way_of_working new decision_record [NAME]
-
-Where `[NAME]` is the title of your decision record, for example:
-
-    way_of_working new decision_record "Use Markdown Any Decision Records"
-
-### Linter
-
-To add [MegaLinter](https://megalinter.io/) to your project, run the following at the command line:
-
-    way_of_working init linter
-
-to run MegaLinter in your project, run:
-
-    way_of_working exec linter
-
 ### Initialise All Components
 
 To add all the Way of Working components to your project, run:
 
-    way_of_working init all --contact-method [CONTACT METHOD]
+```bash
+way_of_working init all --contact-method [CONTACT METHOD]
+```
 
-Providing the Code of Conduct `[CONTACT METHOD]` described above.
+You will need to provide the Code of Conduct `[CONTACT METHOD]`, usually an email address, for community leaders to receive reports of unacceptable behavior.
 
 ### Help
 
 More help on using the command line tool is found by using:
 
-    way_of_working help
+```bash
+way_of_working help
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. This RubyGem was created using `bundle gem --exe way_of_working`.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+This RubyGem was created using `bundle gem --exe way_of_working`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+When creating plugins, the convention is to create them within the WayOfWorking and feature namespaces. E.g. 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/HealthDataInsight/way_of_working>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/HealthDataInsight/way_of_working/blob/main/CODE_OF_CONDUCT.md).
@@ -97,5 +85,15 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 Everyone interacting in the WayOfWorking project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HealthDataInsight/way_of_working/blob/main/CODE_OF_CONDUCT.md).
 
-[changelog]: ./CHANGELOG.md
-[changelog-badge]: https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735
+[alex]:https://alexjs.com
+[Contributor Covenant v2.1]: https://www.contributor-covenant.org
+[keepachangelog v1.1]: https://keepachangelog.com/en/1.1.0/
+[MADR v3]: https://adr.github.io/madr/
+[MegaLinter]: https://megalinter.io/
+[RuboCop]: https://rubocop.org
+[changelog-keepachangelog]: https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog
+[code_linting-hdi]: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi
+[code_of_conduct-contributor_covenant]: https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant
+[decision_record-madr]: https://github.com/HealthDataInsight/way_of_working-decision_record-madr
+[inclusive_language-alex]: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex
+[pull_request_template-hdi]: https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi

data/exe/way_of_working

@@ -2,4 +2,4 @@
 
 require 'way_of_working'
 
-WayOfWorking::CLI.start(ARGV)
+WayOfWorking::Cli.start(ARGV)

data/lib/tasks/audit_gems.rake

@@ -5,7 +5,7 @@ GEM_VERSION_PLATFORM_REGEXP = /
   (?:-(java|(?:aarch|arm|x)(?:86)?(?:_)?(?:64)?-(?:darwin|linux|mingw32|mingw-ucrt)))?
   \.gem
   \z
-/ix.freeze
+/ix
 
 namespace :audit do
   desc 'This tasks audits vendored gems, comparing file digests with published ones'
@@ -21,7 +21,7 @@ namespace :audit do
     git_user_name = git_base.config('user.name')
     failed = false
 
-    Dir['vendor/cache/*.gem'].sort.each do |path|
+    Dir['vendor/cache/*.gem'].each do |path|
       file_digest = Digest::SHA256.file(path).hexdigest
       file_name = File.basename(path)
       matchdata = GEM_VERSION_PLATFORM_REGEXP.match(file_name)

data/lib/way_of_working/cli.rb

@@ -1,125 +1,21 @@
 # frozen_string_literal: true
 
-require_relative 'generators/changelog/init'
-require_relative 'generators/code_of_conduct/init'
-require_relative 'generators/decision_record/init'
-require_relative 'generators/decision_record/new'
-require_relative 'generators/linter/exec'
-require_relative 'generators/linter/init'
-require_relative 'generators/rake_tasks/init'
-require_relative 'sub_command_base'
+require 'thor'
 
-module WayOfWorking
-  # This class defines the exec (i.e. run) parent command
-  class Exec < SubCommandBase
-    register(Generators::Linter::Exec, 'linter', 'linter',
-             <<~LONGDESC)
-               Description:
-                   This runs the linter on this project
-
-               Example:
-                   way_of_working exec linter
-             LONGDESC
-  end
-
-  # This class defines the "init" parent command
-  class Init < SubCommandBase
-    desc 'all --contact-method [CONTACT METHOD]',
-         'This adds all of the available Way of Working components to this project'
-    method_option :contact_method, required: true
-    def all
-      invoke_all
-    end
-
-    register(Generators::Changelog::Init, 'changelog', 'changelog',
-             <<~LONGDESC)
-               Description:
-                   This adds the Keep a Changelog v1.1 changelog to the project
-
-               Example:
-                   way_of_working init changelog
-
-                   This will create:
-                   CHANGELOG.md
-             LONGDESC
-
-    register(Generators::CodeOfConduct::Init, 'code_of_conduct',
-             'code_of_conduct --contact-method [CONTACT METHOD]',
-             <<~LONGDESC)
-               Description:
-                   This adds the Contributor Covenant v2.1 code of conduct to the project
-
-               Example:
-                   way_of_working init code_of_conduct --contact-method "foo@bar.com"
-
-                   This will create:
-                       CODE_OF_CONDUCT.md
-             LONGDESC
-
-    register(Generators::DecisionRecord::Init, 'decision_record', 'decision_record',
-             <<~LONGDESC)
-               Description:
-                   This generator adds Markdown Any Decision Records (MADR) to your project
-
-               Example:
-                   way_of_working init decision_record
-
-                   This will create:
-                       docs/decisions/README.md
-                       docs/decisions/adr-template.md
-                       docs/decisions/0000-use-markdown-any-decision-records.md
-             LONGDESC
-
-    register(Generators::Linter::Init, 'linter', 'linter',
-             <<~LONGDESC)
-               Description:
-                   Installs MegaLinter config files into the project
-
-               Example:
-                   way_of_working init linter
-
-                   This will create:
-                       .github/workflows/mega-linter.yml
-                       .mega-linter.yml
-             LONGDESC
-
-    register(Generators::RakeTasks::Init, 'rake_tasks', 'rake_tasks',
-             <<~LONGDESC)
-               Description:
-                   Installs Way of Working rake tasks into this project
-
-               Example:
-                   way_of_working init rake_tasks
-
-                   This will amend or create:
-                       Rakefile
-             LONGDESC
-  end
-
-  # This class defines the "new" parent command
-  class New < SubCommandBase
-    register(Generators::DecisionRecord::New, 'decision_record', 'decision_record [NAME]',
-             <<~LONGDESC)
-               Description:
-                   This generator adds a new decision record to your project
-
-               Example:
-                   way_of_working new decision_record "Title of the decision"
-
-                   This will create:
-                       docs/decisions/NNNN-title-of-the-decision.md
-             LONGDESC
-  end
+require_relative 'sub_commands/exec'
+require_relative 'sub_commands/init'
+require_relative 'sub_commands/new'
 
+module WayOfWorking
   # This class defines the top level interface
-  class CLI < Thor
+  class Cli < Thor
+    desc 'exec [COMPONENT]', 'Executes (runs) the specific component'
+    subcommand 'exec', ::WayOfWorking::SubCommands::Exec
+
     desc 'init [COMPONENT]', 'Initialises Way of Working components'
-    subcommand 'init', Init
+    subcommand 'init', ::WayOfWorking::SubCommands::Init
 
     desc 'new [THING]', 'Creates new things'
-    subcommand 'new', New
-
-    desc 'exec [COMPONENT]', 'Executes (runs) the specific component'
-    subcommand 'exec', Exec
+    subcommand 'new', ::WayOfWorking::SubCommands::New
   end
 end

data/lib/way_of_working/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WayOfWorking
+  # This class stores config information
+  class Configuration
+    class << self
+      attr_writer :organisation_abbreviation, :organisation_gem_version
+
+      def main_badge_name
+        [@organisation_abbreviation, 'Way of Working'].compact.join(' ')
+      end
+
+      def main_badge_version
+        @organisation_gem_version || WayOfWorking::VERSION
+      end
+    end
+  end
+end

data/lib/way_of_working/git/repo_reader.rb

@@ -35,9 +35,7 @@ module WayOfWorking
         tags.each do |tag|
           next if tag.version.nil?
 
-          if previous_version && tag.version <= previous_version
-            raise 'Tag versions are not incremental over time'
-          end
+          raise 'Tag versions are not incremental over time' if previous_version && tag.version <= previous_version
 
           previous_version = tag.version
         end

data/lib/way_of_working/paths.rb

@@ -2,9 +2,10 @@
 
 require 'pathname'
 
-# Mixin that provides a couple of pathname convenience methods
+# The Way of Working namespace
 module WayOfWorking
-  class << self
+  # Mixin that provides a couple of pathname convenience methods
+  module Paths
     def root
       Pathname.new(File.expand_path('../..', __dir__))
     end
@@ -13,4 +14,6 @@ module WayOfWorking
       root.join('lib', 'way_of_working', 'templates')
     end
   end
+
+  extend Paths
 end

data/lib/way_of_working/readme_badge/generators/init.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'way_of_working/readme_badge/paths'
+
+module WayOfWorking
+  module ReadmeBadge
+    module Generators
+      HOLDER_END_TAG = "<!-- Way of Working: Badge Holder End -->\n"
+
+      # This generator adds the alexrc file
+      class Init < Thor::Group
+        include Thor::Actions
+
+        source_root ::WayOfWorking::ReadmeBadge.source_root
+
+        def create_template_readme_if_missing
+          template_if_missing 'README.md'
+        end
+
+        def insert_badge_holder_into_readme
+          content = <<~MARKDOWN + HOLDER_END_TAG
+
+            <!-- Way of Working: Main Badge Holder Start -->
+            #{main_badge}
+            <!-- Way of Working: Additional Badge Holder Start -->
+          MARKDOWN
+
+          insert_into_file 'README.md', content, after: /^#\s.*?\n/
+        end
+
+        def copy_way_of_working_documentation
+          template 'docs/way_of_working/readme-badges.md'
+        end
+
+        private
+
+        def main_badge
+          shield_url = 'https://img.shields.io/badge/' \
+                       "#{WayOfWorking::Configuration.main_badge_name.gsub(' ', '_')}-" \
+                       "v#{WayOfWorking::Configuration.main_badge_version}-%238169e3?labelColor=black"
+          "![#{WayOfWorking::Configuration.main_badge_name} Badge](#{shield_url})"
+        end
+
+        def template_if_missing(path)
+          destination_path = File.join(destination_root, path)
+          return if behavior == :revoke || File.exist?(destination_path)
+
+          template(path)
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/readme_badge/github_audit_rule.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'way_of_working/audit/github/rules/base'
+
+module WayOfWorking
+  # Namespace for the "internal" ReadmeBadge rule
+  module ReadmeBadge
+    # This rule checks for a README and Way of Working badge.
+    class GithubAuditRule < ::WayOfWorking::Audit::Github::Rules::Base
+      def valid?
+        @errors << 'No README' if readme_content.nil?
+        @errors << 'No Way of Working README Badge' unless readme_way_of_working_badge?
+
+        @errors.empty? ? :passed : :failed
+      end
+
+      private
+
+      def readme_way_of_working_badge?
+        readme_content.include?('Way of Working Badge](https://img.shields.io/badge/')
+      end
+    end
+
+    ::WayOfWorking::Audit::Github::Rules::Registry.register(GithubAuditRule,
+                                                            'Project README and Way of Working badge')
+  end
+end

data/lib/way_of_working/readme_badge/paths.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module WayOfWorking
+  # Mixin that provides a couple of pathname convenience methods
+  module ReadmeBadge
+    class << self
+      def root
+        Pathname.new(File.expand_path('../../..', __dir__))
+      end
+
+      def source_root
+        root.join('lib', 'way_of_working', 'readme_badge', 'templates')
+      end
+    end
+  end
+end

data/lib/way_of_working/readme_badge/templates/README.md

@@ -0,0 +1,3 @@
+# {name of project}
+
+Read the GitHub documentation to [learn more about READMEs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes).

data/lib/way_of_working/readme_badge/templates/docs/way_of_working/readme-badges.md.tt

@@ -0,0 +1,24 @@
+---
+layout: page
+---
+# README Badges
+
+Badges at the top of a project's README file are a powerful tool for providing immediate, concise, and digestible information about a project.
+
+They are an important feature, as they communicate crucial insights such as the build status, test coverage, package version, licensing information, or even the platform compatibility of the project, all at a glance. Badges allow developers to quickly gauge the project's health, and maintenance level, without delving into the project's codebase or documentation.
+
+Moreover, badges can help foster a sense of openness and reliability within the open-source community, as they provide a transparent snapshot of the project's current state. This makes them essential to building trust and confidence in a project, which can facilitate broader adoption and community involvement.
+
+Our badge "panel" is a set of predefined HTML comments that top and tail Way of Working badges in the README, so that other generators within the framework can automatically find the panel and add their badge(s) to it.
+
+<%= main_badge %>
+
+We have created a Way of Working badge to identify at a glance that a project has adopted the Way of Working.
+
+## Usage
+
+To add the badge "panel" and Way of Working badge to your project, use the following at the command line:
+
+```bash
+way_of_working init readme_badge
+```

data/lib/way_of_working/readme_badge.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'readme_badge/generators/init'
+
+# If way_of_working-audit-github is used we can add a rule
+github_audit_used =
+  begin
+    require 'way_of_working/audit/github/rules/registry'
+  rescue LoadError
+    false
+  end
+require_relative 'readme_badge/github_audit_rule' if github_audit_used
+
+module WayOfWorking
+  module SubCommands
+    # This reopens the "way_of_working init" sub command
+    class Init
+      register(WayOfWorking::ReadmeBadge::Generators::Init, 'readme_badge', 'readme_badge',
+               <<~LONGDESC)
+                 Description:
+                     Installs Way of Working readme badge and badge holder into this project
+
+                 Example:
+                     way_of_working init readme_badge
+
+                     This will amend or create:
+                         README.md
+               LONGDESC
+    end
+  end
+end

data/lib/way_of_working/sub_commands/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module WayOfWorking
+  module SubCommands
+    # This base class enables subcommands to work correctly with help. See:
+    # https://github.com/rails/thor/wiki/Subcommands#subcommands-that-work-correctly-with-help
+    class Base < Thor
+      def self.banner(command, _namespace = nil, _subcommand = false)
+        "#{basename} #{subcommand_prefix} #{command.usage}"
+      end
+
+      def self.subcommand_prefix
+        name.gsub(/.*::/, '').gsub(/^[A-Z]/) { |match| match[0].downcase }.
+          gsub(/[A-Z]/) { |match| "-#{match[0].downcase}" }
+      end
+    end
+  end
+end

data/lib/way_of_working/sub_commands/exec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WayOfWorking
+  module SubCommands
+    # This class defines the exec (i.e. run) parent command
+    class Exec < Base
+    end
+  end
+end

data/lib/way_of_working/sub_commands/init.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WayOfWorking
+  module SubCommands
+    # This class defines the "init" parent command
+    class Init < Base
+      desc 'all --contact-method [CONTACT METHOD]',
+           'This adds all of the available Way of Working components to this project'
+      method_option :contact_method, required: true
+      def all
+        invoke_all
+      end
+    end
+  end
+end

data/lib/way_of_working/sub_commands/new.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WayOfWorking
+  module SubCommands
+    # This class defines the "way_of_working new ..." sub command
+    class New < Base
+    end
+  end
+end