way_of_working 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcf87e5f8b8338ec91dc10bb579a9c8e9fa3e977745ba61cf8ae106cfb27201c
-  data.tar.gz: 3be69c82e3d055cefe8353bf440f085eb84f420427a131dbb4a5f888f12d67f6
+  metadata.gz: a018ad36100c846ff6876cd4db5a6228fca2c0264b505971795559dd75a39d3b
+  data.tar.gz: 69cb609754aba06b2fd2b3b99171cf3cb09c84651a3986aad054f9121664eca5
 SHA512:
-  metadata.gz: 70c5587a836fd9d530647f01e96fd725ac91ac418415e0d002613da943dfc502d6460d454bf81e9ea2c5f05ccfd78ef94b2b75adf8ca16261fa28c327c490a22
-  data.tar.gz: feb65211f0f6c7904c00a16dccdb1b8dde8de7ca3880282d7fe926543dae1de30fed6a1e722843f5bbcfb4dd2735b87dd0c5c6c4b9c9cbb72bf03a0a5a220a02
+  metadata.gz: cf11254e92ca8b5da97f8f77aecbcf1f3883b83d8c0aa3fd7ba51a5ac7720ff4fa4bb6a65f32fe634d2e08c250a8522997cfadd6856820aee59a7c59dec7dd8d
+  data.tar.gz: a7b8040aa306c657a8691ad3ce7061a4a42073ab1ac0124b2187ed6bc40f9f3411d58621c6db1d22f646534e73585d1646aeea94dd8bdb21be57381b4ff6c41c

data/CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.0] - 2026-06-08
+
+### Added
+
+- **Audit:** bundled the GitHub audit feature into this gem. It is opt in and replaces the separate `way_of_working-audit-github` plugin gem.
+- **Changelog:** bundled the Keep a Changelog feature into this gem. It is opt in and replaces the separate `way_of_working-changelog-keepachangelog` plugin gem.
+- **Code of Conduct:** bundled the Contributor Covenant feature into this gem. It is opt in and replaces the separate `way_of_working-code_of_conduct-contributor_covenant` plugin gem.
+- **Decision Records:** bundled the MADR feature into this gem. It is opt in and replaces the separate `way_of_working-decision_record-madr` plugin gem.
+- **Inclusive Language:** bundled the alex feature into this gem. It is opt in and replaces the separate `way_of_working-inclusive_language-alex` plugin gem.
+- **Pull Request Template:** bundled the HDI feature into this gem. It is opt in and replaces the separate `way_of_working-pull_request_template-hdi` plugin gem.
+- **Versioning:** bundled the Semantic Versioning feature into this gem. It is opt in and replaces the separate `way_of_working-versioning-semver` plugin gem.
+- **Versioning:** documented the versioning policy in [ADR-0001](docs/decisions/0001-version-the-gem-interface-not-generated-content.md) and `CONTRIBUTING.md` — SemVer governs the gem's interface, not generated content; standard refreshes are minor, and drastic upgrades ship as additive variants.
+
+## [2.0.1] - 2025-01-17
+
+### Removed
+
+- Removed completely unused test resource file
+
+### Fixed
+
+- Corrected the badge rule brittle loading and signature
+- Resolved YAML linting issues
+
+## [2.0.0] - 2024-10-24
+
 ### Added
 
 - Added a panel for README badges and a Way of Working badge
@@ -48,5 +74,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Corrected use of relative paths in the rubocop config file
 
-[unreleased]: https://github.com/HealthDataInsight/way_of_working/compare/v1.0.0...HEAD
+[unreleased]: https://github.com/HealthDataInsight/way_of_working/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/HealthDataInsight/way_of_working/compare/v2.0.1...v2.1.0
+[2.0.1]: https://github.com/HealthDataInsight/way_of_working/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/HealthDataInsight/way_of_working/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/HealthDataInsight/way_of_working/releases/tag/v1.0.0

data/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# 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](CODE_OF_CONDUCT.md).
+
+## 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 lets you experiment.
+
+## Versioning
+
+This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html), but SemVer here
+governs the gem's **public interface**, not the content of the artefacts its generators emit. The
+versioned contract is:
+
+* the **CLI surface** — commands and their required options;
+* the **require paths** of built-in features
+  (e.g. `require 'way_of_working/code_of_conduct/contributor_covenant'`);
+* the **plugin registration API** (`SubCommands::*.register`, the `way_of_working-*` autoload).
+
+Refreshing the standard a feature embeds (e.g. a new Contributor Covenant or MADR version) changes
+generated content but not the interface, so it is **not** a major change. See
+[ADR-0001](docs/decisions/0001-version-the-gem-interface-not-generated-content.md) for the full
+rationale.
+
+### Choosing the version bump
+
+| Change | Bump |
+| --- | --- |
+| Rename/remove a command or required option, move a feature's require path, or change the plugin API | **MAJOR** |
+| Refresh the standard a feature embeds; add a new feature or variant | **MINOR** |
+| Drastic standard upgrade shipped as a **new variant** alongside the existing one | **MINOR** (additive) |
+| Bug fix in generation or generated output | **PATCH** |
+
+For a standard update drastic enough to surprise existing users (e.g. Contributor Covenant
+2.1 → 3, effectively a rewrite), add a **new variant** under the feature's `category/variant`
+namespace rather than mutating the existing one. Both variants then coexist and consumers opt in by
+require path — keeping the change additive and leaving existing users untouched.
+
+### Changelog convention
+
+All notable changes are recorded in `CHANGELOG.md` following
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Scope feature-affecting entries with a
+bold feature prefix so each feature's history stays greppable within the single file, e.g.:
+
+```text
+- **Code of Conduct:** upgraded Contributor Covenant 2.1 → 3 via new `contributor_covenant_v3` variant
+```
+
+## Releasing
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version:
+
+1. Decide the bump using the table above.
+2. Update the version number in `lib/way_of_working/version.rb`.
+3. Move the `[Unreleased]` changelog entries under the new version heading.
+4. Run `bundle exec rake release`, which creates a git tag for the version, pushes the commits and
+   tag, and pushes the `.gem` file to [rubygems.org](https://rubygems.org).

data/README.md

@@ -1,7 +1,7 @@
 # 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 Badge](https://img.shields.io/badge/Way_of_Working-v2.0.1-%238169e3?labelColor=black)
 <!-- Way of Working: Additional Badge Holder Start -->
 <!-- Way of Working: Badge Holder End -->
 
@@ -21,14 +21,20 @@ There are subcommands that plugins hook into which enable them to add GitHub act
 
 Below is a list of plugins that have been implemented so far:
 
-| 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                                               |
+| Feature               | Plugin                                 | Description                                                                            |
+| --------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------|
+| Audit                 | Built-in (audit/github)                | A framework for rules to check for incorrect content and configuration of GitHub repos — bundled, opt in by `require` (see [Built-in Features](#built-in-features)) |
+| Changelog             | Built-in (changelog/keepachangelog)    | Implements [keepachangelog v1.1] — bundled, opt in by `require` (see [Built-in Features](#built-in-features)) |
+| Code Linting          | [code_linting-hdi]                     | Implements a combination of [MegaLinter] and [RuboCop] built on NDRS standards         |
+| Code of Conduct       | Built-in (code_of_conduct/contributor_covenant) | Implements [Contributor Covenant v2.1] — bundled, opt in by `require` (see [Built-in Features](#built-in-features)) |
+| Decision Records      | Built-in (decision_record/madr)        | Implements [MADR v3] — bundled, opt in by `require` (see [Built-in Features](#built-in-features)) |
+| Inclusive Language    | Built-in (inclusive_language/alex)     | Implements [alex] — bundled, opt in by `require` (see [Built-in Features](#built-in-features)) |
+| Pull Request Template | Built-in (pull_request_template/hdi)   | Implements a bespoke PR template — bundled, opt in by `require` (see [Built-in Features](#built-in-features)) |
+| Versioning            | Built-in (versioning/semver)           | Implements [Semantic Versioning v2.0.0] — bundled, opt in by `require` (see [Built-in Features](#built-in-features)) |
+
+Some features are **Built-in** — they ship inside this gem and are enabled by requiring them (see [Built-in Features](#built-in-features)); the others are separate plugin gems that you add as dependencies.
+
+The standard versions cited above (Contributor Covenant v2.1, MADR v3, and so on) describe the content a feature generates, not the gem's interface. They advance through **minor** releases — see [Versioning Policy](#versioning-policy).
 
 ## Installation
 
@@ -56,6 +62,161 @@ way_of_working init all --contact-method [CONTACT METHOD]
 
 You will need to provide the Code of Conduct `[CONTACT METHOD]`, usually an email address, for community leaders to receive reports of unacceptable behavior.
 
+### Built-in Features
+
+Some features are bundled with this gem rather than shipped as separate plugins. These built-in features are **opt in**: enable one by requiring it wherever you load Way of Working — for example in your organisation's Way of Working gem, or in your project's `Rakefile`.
+
+#### Audit
+
+Auditing your GitHub repositories against a consistent set of rules catches missing or misconfigured files and repository settings across an organisation, keeping projects aligned with your way of working. Many of the other built-in features register their own rules to check that they have been adopted properly.
+
+This feature provides a registry and auditing tool for GitHub repositories; rules can check for both missing/incorrect files and mis-configuration of the repository itself. Enable it by requiring it:
+
+```ruby
+require 'way_of_working/audit/github'
+```
+
+The audit needs two environment variables:
+
+- `GITHUB_ORGANISATION`: the name of your organisation being scanned (as used in the GitHub URL)
+- `GITHUB_TOKEN`: a PAT token with sufficient permission to access repositories and their configuration
+
+Once required, a subcommand becomes available. By default it runs only against repositories configured as git remotes in your current project:
+
+```bash
+# Audit this project's GitHub repositories
+way_of_working exec audit_github
+```
+
+Flags let you widen or narrow the scope:
+
+```bash
+# Audit every repository in the organisation
+way_of_working exec audit_github --all
+
+# Filter to repositories carrying a topic
+way_of_working exec audit_github --all --topic way-of-working
+
+# Audit one or more repositories by name (implies the whole organisation)
+way_of_working exec audit_github --name structured_store other_repo
+
+# Audit only public repositories
+way_of_working exec audit_github --all --public
+
+# Attempt to automatically fix issues where rules support it
+way_of_working exec audit_github --fix
+```
+
+#### Changelog
+
+Keeping a curated, human-readable changelog helps users and contributors quickly see what has changed between releases without trawling through the commit history.
+
+This feature uses [Keep a Changelog v1.1][keepachangelog v1.1] to generate a `CHANGELOG.md`, seeding it with sections derived from your git tags and commit messages where possible. Enable it by requiring it:
+
+```ruby
+require 'way_of_working/changelog/keepachangelog'
+```
+
+Once required, a subcommand becomes available:
+
+```bash
+# Add a Keep a Changelog CHANGELOG.md and documentation to your project
+way_of_working init changelog
+```
+
+#### Code of Conduct
+
+A code of conduct sets clear expectations for acceptable behaviour within a community or project, helping to create a safer, more welcoming and inclusive environment and giving maintainers a basis for addressing inappropriate behaviour.
+
+This feature installs the [Contributor Covenant v2.1] code of conduct along with its accompanying documentation. Enable it by requiring it:
+
+```ruby
+require 'way_of_working/code_of_conduct/contributor_covenant'
+```
+
+Once required, a subcommand becomes available:
+
+```bash
+# Add the Contributor Covenant code of conduct and documentation to your project
+way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
+```
+
+You will need to provide a `[CONTACT METHOD]`, usually an email address, for community leaders to receive reports of unacceptable behavior.
+
+#### Decision Records
+
+Recording the context and reasoning behind significant decisions helps current and future contributors understand why a project is the way it is, avoids relitigating settled questions, and onboards newcomers faster.
+
+This feature uses [Markdown Any Decision Records (MADR)][MADR v3] to capture decisions as version-controlled Markdown alongside your code. Enable it by requiring it:
+
+```ruby
+require 'way_of_working/decision_record/madr'
+```
+
+Once required, two subcommands become available:
+
+```bash
+# Add the decision records index, template and first record to your project
+way_of_working init decision_record
+
+# Create a new decision record
+way_of_working new decision_record "Title of the decision"
+```
+
+#### Inclusive Language
+
+Using insensitive and inconsiderate language can cause harm to others, create barriers to communication, and damage relationships. It can make people feel excluded, disrespected, and devalued, and may perpetuate negative stereotypes and biases.
+
+This feature uses [alex] for automated testing of inclusive language, both at the command line and as a GitHub workflow. Enable it by requiring it:
+
+```ruby
+require 'way_of_working/inclusive_language/alex'
+```
+
+Once required, two subcommands become available:
+
+```bash
+# Add the alex config, .alexignore, GitHub Action and documentation to your project
+way_of_working init inclusive_language
+
+# Run the inclusive language checks
+way_of_working exec inclusive_language
+```
+
+#### Pull Request Template
+
+A consistent pull request template standardises PR submissions, giving reviewers the context they need, improving review efficiency, and keeping a searchable project history.
+
+This feature installs a bespoke HDI pull request template along with its accompanying guidelines documentation. Enable it by requiring it:
+
+```ruby
+require 'way_of_working/pull_request_template/hdi'
+```
+
+Once required, a subcommand becomes available:
+
+```bash
+# Add the pull request template and documentation to your project
+way_of_working init pull_request_template
+```
+
+#### Versioning
+
+A shared versioning standard makes software changes clear to communicate and releases predictable to manage across projects, so consumers can reason about compatibility at a glance.
+
+This feature documents [Semantic Versioning v2.0.0] as the project's versioning standard. Enable it by requiring it:
+
+```ruby
+require 'way_of_working/versioning/semver'
+```
+
+Once required, a subcommand becomes available:
+
+```bash
+# Add the Semantic Versioning documentation to your project
+way_of_working init versioning
+```
+
 ### Help
 
 More help on using the command line tool is found by using:
@@ -73,10 +234,26 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 When creating plugins, the convention is to create them within the WayOfWorking and feature namespaces. E.g. 
 
+### Versioning Policy
+
+This project follows [Semantic Versioning][Semantic Versioning v2.0.0], but SemVer governs the gem's **public interface** — the CLI commands and their options, the require paths of built-in features, and the plugin registration API — not the content of the artefacts its generators emit.
+
+Consequently:
+
+- Refreshing the standard a feature embeds (e.g. a new Contributor Covenant or MADR version) is **new behaviour → MINOR**.
+- A bug fix in generation is **PATCH**.
+- **MAJOR** is reserved for breaking the interface above (renaming or removing a command or option, moving a require path, or changing the plugin API).
+
+For a standard update drastic enough to surprise existing users, we add a **new variant** under the feature's `category/variant` namespace rather than mutating the existing one, so both coexist and consumers opt in by require path. This keeps the change additive (MINOR) and leaves existing users untouched.
+
+See [ADR-0001](docs/decisions/0001-version-the-gem-interface-not-generated-content.md) for the full rationale and [`CONTRIBUTING.md`](CONTRIBUTING.md) for the version-bump checklist.
+
 ## 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).
 
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development setup, the versioning policy and the release process.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -91,9 +268,5 @@ Everyone interacting in the WayOfWorking project's codebases, issue trackers, ch
 [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
+[Semantic Versioning v2.0.0]: https://semver.org/spec/v2.0.0.html
 [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/lib/way_of_working/audit/github/auditor.rb

@@ -0,0 +1,44 @@
+require 'octokit'
+require_relative 'rules/registry'
+
+module WayOfWorking
+  module Audit
+    module Github
+      # This auditor runs all the rules against any given GitHub repository
+      class Auditor
+        def initialize(access_token, organisation_name, fix = false)
+          @access_token = access_token
+          @organisation_name = organisation_name
+          @fix = fix
+        end
+
+        def audit(repository)
+          # Get all the rules once, rather than repeatedly in individual rules
+          rulesets = @client.get("repos/#{repository.full_name}/rulesets").map do |rule|
+            @client.get("repos/#{repository.full_name}/rulesets/#{rule[:id]}")
+          end
+
+          Array(Rules::Registry.rules).each do |rule_name, klass|
+            rule = klass.new(client, rule_name, repository, rulesets, @fix)
+
+            yield rule
+          end
+        end
+
+        def repositories
+          @repositories ||= client.org_repos(@organisation_name)
+        end
+
+        private
+
+        def client
+          @client ||= begin
+            client = Octokit::Client.new(access_token: @access_token) # , per_page: 1_000
+            client.auto_paginate = true
+            client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/audit/github/generators/exec.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require 'git'
+require 'rainbow'
+require 'thor'
+require 'way_of_working/audit/github/auditor'
+# require 'way_of_working/github_audit/rules/all'
+
+module WayOfWorking
+  module Audit
+    module Github
+      module Generators
+        # This generator runs the github audit
+        class Exec < Thor::Group
+          class_option :all, type: :boolean, default: false,
+                             desc: 'Audit all repositories in the organisation (not just this repo)'
+
+          class_option :fix, type: :boolean, default: false,
+                             desc: 'Attempt to automatically fix issues where possible'
+
+          class_option :name, type: :array, default: nil,
+                              desc: 'Filter repositories by name (e.g., structured_store)'
+
+          class_option :public, type: :boolean, default: false,
+                                desc: 'Filter to only public repositories'
+
+          class_option :topic, type: :string, default: nil,
+                               desc: 'Filter repositories by topic (e.g., way-of-working)'
+
+          desc 'This runs the github audit on this project'
+
+          def check_for_github_token_environment_variables
+            @github_token = ENV.fetch('GITHUB_TOKEN', nil)
+            return unless @github_token.nil?
+
+            abort(Rainbow("\nMissing GITHUB_TOKEN environment variable").red)
+          end
+
+          def check_for_github_organisation_environment_variables
+            @github_organisation = ENV.fetch('GITHUB_ORGANISATION', nil)
+            return unless @github_organisation.nil?
+
+            abort(Rainbow("\nMissing GITHUB_ORGANISATION environment variable").red)
+          end
+
+          def start_timer
+            @start_time = Time.now
+          end
+
+          def check_github_organisation_remotes
+            abort(Rainbow("\nGitHub is not an upstream repository.").red) if github_organisation_remotes.empty?
+
+            # say("Limiting audit to #{path}\n", :yellow) if path
+            say "\nRunning..."
+          end
+
+          def prep_audit
+            @auditor = ::WayOfWorking::Audit::Github::Auditor.new(@github_token, @github_organisation, options[:fix])
+
+            # Loop though all the repos
+            @repositories = @auditor.repositories
+          rescue Octokit::Unauthorized
+            abort(Rainbow("\nGITHUB_TOKEN has expired or does not have sufficient permission").red)
+          end
+
+          def filter_all_if_specified
+            return if options[:all] || options[:name]
+
+            @repositories = @repositories.select do |repo|
+              github_organisation_remotes.include?(repo.name)
+            end
+          end
+
+          def filter_by_name_array_if_specified
+            return unless options[:name]
+
+            @repositories = @repositories.select do |repo|
+              options[:name].include?(repo.name)
+            end
+          end
+
+          def filter_by_topic_if_specified
+            return unless options[:topic]
+
+            @repositories = @repositories.select do |repo|
+              repo.topics.include?(options[:topic])
+            end
+          end
+
+          def filter_by_visibility_if_specified
+            return unless options[:public]
+
+            @repositories = @repositories.reject(&:private?)
+          end
+
+          def run_audit
+            @audit_ok = true
+            unarchived_repos.each do |repo|
+              @auditor.audit(repo) do |rule|
+                case rule.status
+                when :not_applicable
+                  # Do nothing
+                when :passed
+                  say "  ✅ #{rule.tags.inspect} Passed #{rule.name}"
+                when :failed
+                  say "  ❌ #{rule.tags.inspect} Failed #{rule.name}: #{rule.errors.to_sentence}"
+                  @audit_ok = false
+                else
+                  abort(Rainbow("Unknown response #{rule.status.inspect}").red)
+                end
+              end
+            end
+          end
+
+          def run_last
+            say("\nTotal time taken: #{(Time.now - @start_time).to_i} seconds", :yellow)
+
+            if @audit_ok
+              say("\nGitHub audit succeeded!", :green)
+            else
+              abort(Rainbow("\nGitHub audit failed!").red)
+            end
+          end
+
+          private
+
+          def unarchived_repos(&block)
+            return to_enum(__method__) unless block_given?
+
+            @repositories.each do |repo|
+              next if repo.archived?
+
+              say
+              say("#{repo.name} #{repo.private? ? '🔒' : ''}", :bold)
+              say("#{repo.description} [#{repo.language}]")
+              say(repo.topics.join(' '), :cyan) unless repo.topics.empty?
+
+              block.call(repo)
+            end
+          end
+
+          # This method returns the repo names for all upstream repositories
+          # hosted on GitHub, for the given organisation
+          def github_organisation_remotes
+            @github_organisation_remotes ||= begin
+              all_remote_urls = ::Git.open('.').remotes.map(&:url)
+
+              organisation_remote_urls = all_remote_urls.select do |url|
+                url.start_with?("https://github.com/#{@github_organisation}")
+              end
+
+              organisation_remote_urls.map do |url|
+                matchdata = url.match(%r{\Ahttps://github.com/([^/]+)/([^/]+)\.git})
+
+                matchdata[2]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/audit/github/rules/base.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'base64'
+require 'octokit'
+require_relative 'registry'
+
+module WayOfWorking
+  module Audit
+    module Github
+      module Rules
+        # This is the base class for GitHub audit rules
+        class Base
+          attr_accessor :errors, :name, :rulesets, :warnings
+          attr_reader :fix
+
+          class << self
+            # Stores and return the source root for this class
+            def source_root(path = nil)
+              @source_root = path if path
+              @source_root ||= nil
+            end
+          end
+
+          def initialize(client, name, repo, rulesets, fix = false)
+            @client = client
+            @name = name
+            @repo = repo
+            @repo_name = repo.full_name
+            @rulesets = rulesets
+            @fix = fix
+            @errors = []
+            @warnings = []
+          end
+
+          def status
+            @status ||= begin
+              result = validate
+
+              if result == :not_applicable
+                result
+              else
+                @errors.empty? ? :passed : :failed
+              end
+            end
+          end
+
+          def validate
+            $stdout.puts "Rule#valid? has been deprecated, use \"validate\" in #{self.class.name}"
+            valid?
+          end
+
+          def self.tags
+            [:way_of_working]
+          end
+
+          def tags
+            self.class.tags
+          end
+
+          private
+
+          def repo_file_contents(path)
+            response = @client.contents(@repo_name, path: path)
+            Base64.decode64(response.content).force_encoding('UTF-8')
+          rescue Octokit::NotFound
+            nil
+          end
+
+          # This method returns the content of the README file
+          def readme_content
+            @readme_content ||=
+              begin
+                response = @client.readme(@repo_name)
+
+                Base64.decode64(response.content).force_encoding('UTF-8')
+              rescue Octokit::NotFound
+                ''
+              end
+          end
+
+          # This convenience method returns the branch rules for this repo
+          def branch_rules(branch)
+            @client.get("repos/#{@repo.full_name}/rules/branches/#{branch}")
+          end
+        end
+      end
+    end
+  end
+end