way_of_working-pull_request_template-hdi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b45e945da2dedac0b926efb4af038c97a8bd1eb8e18973e6b72100cdd43aca3d
+  data.tar.gz: a74593e1e7aae26971c560f972c96b52125d3ab54139a4ad4545a3f51a3034f1
+SHA512:
+  metadata.gz: 31d83c61120ceabd37eeb52407b32193c3d56eaaf2c6f81bc72fd4ebba2e98b46e79f479c386e52abbaf16a7e6288b87f54942ec3297779b4a31b114cbf8a322
+  data.tar.gz: ce6d455f0ff60950d160db9696d09059fbadf994bcdb8a854b5189d20b32e669fd88c06303f0f2a467b178a220ef47dd376a0b6806f24d3250315919849fc927

data/.alexrc

@@ -0,0 +1,3 @@
+{
+  "profanitySureness": 1
+}

data/.mega-linter.yml

@@ -0,0 +1,145 @@
+---
+# Configuration file for MegaLinter
+# See all available variables at https://megalinter.io/configuration/
+# and in linters documentation
+
+APPLY_FIXES: none  # all, none, or list of linter keys
+ENABLE_LINTERS:  # All other linters will be disabled by default
+  ### Languages
+  - BASH_EXEC  # in Super-Linter
+  - BASH_SHELLCHECK  # in Super-Linter
+  - BASH_SHFMT  # in Super-Linter
+  - C_CLANG_FORMAT
+  - C_CPPLINT
+  # - CLOJURE_CLJ_KONDO  # in Super-Linter
+  # - CLOJURE_CLJSTYLE
+  - COFFEE_COFFEELINT  # in Super-Linter
+  - CPP_CLANG_FORMAT
+  - CPP_CPPLINT  # in Super-Linter
+  - CSHARP_CSHARPIER
+  - CSHARP_DOTNET_FORMAT  # in Super-Linter
+  - CSHARP_ROSLYNATOR
+  - DART_DARTANALYZER  # in Super-Linter
+  - GO_GOLANGCI_LINT  # in Super-Linter
+  - GO_REVIVE
+  # - GROOVY_NPM_GROOVY_LINT  # in Super-Linter
+  - JAVA_CHECKSTYLE  # in Super-Linter
+  - JAVA_PMD
+  - JAVASCRIPT_ES  # in Super-Linter
+  # - JAVASCRIPT_PRETTIER
+  - JAVASCRIPT_STANDARD  # in Super-Linter
+  - JSX_ESLINT
+  - KOTLIN_DETEKT
+  - KOTLIN_KTLINT  # in Super-Linter
+  # - LUA_LUACHECK  # in Super-Linter
+  # - LUA_SELENE
+  # - LUA_STYLUA
+  - MAKEFILE_CHECKMAKE
+  # - PERL_PERLCRITIC  # in Super-Linter
+  # - PHP_BUILTIN
+  # - PHP_PHPCS  # in Super-Linter
+  # - PHP_PHPCSFIXER
+  # - PHP_PHPLINT  # in Super-Linter
+  # - PHP_PHPSTAN  # in Super-Linter
+  # - PHP_PSALM  # in Super-Linter
+  # - POWERSHELL_POWERSHELL
+  # - POWERSHELL_POWERSHELL_FORMATTER
+  - PYTHON_BANDIT
+  - PYTHON_BLACK  # in Super-Linter
+  - PYTHON_FLAKE8  # in Super-Linter
+  - PYTHON_ISORT  # in Super-Linter
+  - PYTHON_MYPY
+  - PYTHON_PYLINT  # in Super-Linter
+  - PYTHON_PYRIGHT
+  - PYTHON_RUFF
+  - R_LINTR  # in Super-Linter
+  # - RAKU_RAKU  # in Super-Linter
+  # - RUBY_RUBOCOP  # in Super-Linter
+  - RUST_CLIPPY  # in Super-Linter
+  # - SALESFORCE_LIGHTNING_FLOW_SCANNER
+  # - SALESFORCE_SFDX_SCANNER_APEX
+  # - SALESFORCE_SFDX_SCANNER_AURA
+  # - SALESFORCE_SFDX_SCANNER_LWC
+  - SCALA_SCALAFIX
+  - SQL_SQLFLUFF  # in Super-Linter
+  - SQL_TSQLLINT
+  - SWIFT_SWIFTLINT
+  - TSX_ESLINT
+  - TYPESCRIPT_ES  # in Super-Linter
+  # - TYPESCRIPT_PRETTIER
+  - TYPESCRIPT_STANDARD  # in Super-Linter
+  # - VBDOTNET_DOTNET_FORMAT
+
+  ### Formats
+  - CSS_STYLELINT  # in Super-Linter
+  - ENV_DOTENV_LINTER  # in Super-Linter
+  # - GRAPHQL_GRAPHQL_SCHEMA_LINTER
+  # - HTML_DJLINT # Refuses to see config file
+  - HTML_HTMLHINT  # in Super-Linter
+  - JSON_ESLINT_PLUGIN_JSONC  # in Super-Linter
+  - JSON_JSONLINT
+  - JSON_NPM_PACKAGE_JSON_LINT
+  # - JSON_PRETTIER
+  - JSON_V8R
+  # - LATEX_CHKTEX  # in Super-Linter
+  - MARKDOWN_MARKDOWNLINT  # in Super-Linter
+  - MARKDOWN_MARKDOWN_LINK_CHECK
+  - MARKDOWN_MARKDOWN_TABLE_FORMATTER
+  - MARKDOWN_REMARK_LINT
+  # - PROTOBUF_PROTOLINT  # in Super-Linter
+  # - RST_RSTCHECK
+  # - RST_RSTFMT
+  # - RST_RST_LINT
+  - XML_XMLLINT  # in Super-Linter
+  # - YAML_PRETTIER
+  - YAML_V8R
+  - YAML_YAMLLINT  # in Super-Linter
+
+  ### Tooling
+  - ACTION_ACTIONLINT  # in Super-Linter
+  - ANSIBLE_ANSIBLE_LINT  # in Super-Linter
+  - API_SPECTRAL
+  - ARM_ARM_TTK  # in Super-Linter
+  # - BICEP_BICEP_LINTER
+  - CLOUDFORMATION_CFN_LINT  # in Super-Linter
+  - DOCKERFILE_HADOLINT  # in Super-Linter
+  - EDITORCONFIG_EDITORCONFIG_CHECKER  # in Super-Linter
+  # - GHERKIN_GHERKIN_LINT  # in Super-Linter
+  - KUBERNETES_HELM
+  - KUBERNETES_KUBECONFORM
+  - KUBERNETES_KUBESCAPE
+  - PUPPET_PUPPET_LINT
+  # - SNAKEMAKE_LINT  # in Super-Linter
+  # - SNAKEMAKE_SNAKEFMT  # in Super-Linter
+  # - TEKTON_TEKTON_LINT  # in Super-Linter
+  - TERRAFORM_TERRAFORM_FMT  # in Super-Linter
+  - TERRAFORM_TERRAGRUNT  # in Super-Linter
+  - TERRAFORM_TERRASCAN  # in Super-Linter
+  - TERRAFORM_TFLINT  # in Super-Linter
+
+  ### Code quality checkers
+  - COPYPASTE_JSCPD  # in Super-Linter
+  - REPOSITORY_CHECKOV
+  - REPOSITORY_DEVSKIM
+  - REPOSITORY_DUSTILOCK
+  - REPOSITORY_GIT_DIFF
+  - REPOSITORY_GITLEAKS  # in Super-Linter
+  - REPOSITORY_GRYPE
+  - REPOSITORY_KICS
+  - REPOSITORY_LS_LINT
+  - REPOSITORY_SECRETLINT
+  - REPOSITORY_SEMGREP
+  - REPOSITORY_SYFT
+  - REPOSITORY_TRIVY
+  - REPOSITORY_TRIVY_SBOM
+  - REPOSITORY_TRUFFLEHOG
+  # - SPELL_CSPELL
+  - SPELL_LYCHEE
+  - SPELL_PROSELINT
+  - SPELL_VALE
+
+SHOW_ELAPSED_TIME: false
+FILEIO_REPORTER: false
+FAIL_IF_MISSING_LINTER_IN_FLAVOR: true
+# DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect
+# errors but not block CI to pass

data/.rubocop

@@ -0,0 +1 @@
+--config .github/linters/rubocop_defaults.yml

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2025-01-24
+
+### Added
+
+- Added a Pull Request template and communications guidelines
+- Added a GitHub audit rule to check for the presence of the PR template
+
+[unreleased]: https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi/releases/tag/v1.0.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Health Data Insight CIC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# WayOfWorking::PullRequestTemplate::Hdi
+
+<!-- Way of Working: Main Badge Holder Start -->
+![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 -->
+
+This is a plugin for the [Way of Working](https://github.com/HealthDataInsight/way_of_working) framework. It contains a GitHub Pull Request (PR) template that contains the following section headings:
+
+- What?
+- Why?
+- How?
+- Testing?
+- Screenshots (optional)
+- Anything Else?
+
+It includes inline guidance and examples on filling in the sections.
+
+A Pull Request (PR) template offers multiple benefits to a development team. It standardizes the process of contributing changes, making it easier for both the author and the reviewers to understand the context of the changes. PR templates can ensure that necessary details, such as a summary of the changes, the reason for the changes (the 'why'), and any associated issue or ticket numbers, are consistently provided. This helps in maintaining a clean, organized, and searchable project history.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+To add the Pull Request template to your project, use the following at the command line:
+
+    way_of_working init pull_request_template
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi. 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-pull_request_template-hdi/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the way_of_working-pull_request_template-hdi 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-pull_request_template-hdi/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'way_of_working/tasks'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+  t.warning = false
+end
+
+desc 'Run tests'
+task default: :test

data/code_safety.yml

@@ -0,0 +1,138 @@
+---
+file safety:
+  ".alexrc":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  ".github/linters/.markdown-link-check.json":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  ".github/linters/rubocop_defaults.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  ".github/pull_request_template.md":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  ".github/workflows/inclusive-language.yml":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  ".github/workflows/main.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  ".github/workflows/mega-linter.yml":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  ".gitignore":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  ".mega-linter.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  ".rubocop":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  CHANGELOG.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  Gemfile:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  Gemfile.lock:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  LICENSE.txt:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  README.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  Rakefile:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  bin/console:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  bin/setup:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: b6dfa95b5ff30b730da276f4f5ff4c6f9b62efe9
+  docs/way_of_working/pull-request-template-and-guidelines.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi/generators/init.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi/github_audit_rule.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi/paths.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi/plugin.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi/templates/.github/pull_request_template.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi/templates/docs/way_of_working/pull-request-template-and-guidelines.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  lib/way_of_working/pull_request_template/hdi/version.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  test/test_helper.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  test/way_of_working/audit_github_stub_classes.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  test/way_of_working/pull_request_template/hdi/generators/init_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  test/way_of_working/pull_request_template/hdi/github_audit_rule_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  test/way_of_working/pull_request_template/hdi/zeitwerk_loader_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  test/way_of_working/pull_request_template/hdi_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452
+  way_of_working-pull_request_template-hdi.gemspec:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8a1c4e75959cd233ba1b9f134f792a112c642452

data/docs/way_of_working/pull-request-template-and-guidelines.md

@@ -0,0 +1,18 @@
+---
+layout: page
+---
+
+# Pull Request Template and Guidlines
+
+A Pull Request (PR) template offers multiple benefits to a development team. It standardizes the process of contributing changes, making it easier for both the author and the reviewers to understand the context of the changes. PR templates can ensure that necessary details, such as a summary of the changes, the reason for the changes (the 'why'), and any associated issue or ticket numbers, are consistently provided. This helps in maintaining a clean, organized, and searchable project history.
+
+Moreover, by setting clear expectations about the information that should be included in a PR, templates can streamline the review process, reduce the likelihood of misunderstandings, and ultimately lead to higher-quality code and a more productive team.
+
+{: .important }
+A Pull Request doesn't begin and end with the template, the tone of the request and any subsequent feedback is also very important. Alongside the [Code of Conduct](code-of-conduct.md), please read GitHub's PR communication guidlines in [How to write the perfect pull request](https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/).
+
+## Usage
+
+To add the Pull Request template to your project, use the following at the command line:
+
+    way_of_working init pull_request_template

data/lib/way_of_working/pull_request_template/hdi/generators/init.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module WayOfWorking
+  module PullRequestTemplate
+    module Hdi
+      module Generators
+        # This generator adds the Pull Request template to a project
+        class Init < Thor::Group
+          include Thor::Actions
+
+          source_root ::WayOfWorking::PullRequestTemplate::Hdi.source_root
+
+          def copy_pr_template_action
+            copy_file '.github/pull_request_template.md'
+          end
+
+          def copy_way_of_working_documentation
+            copy_file 'docs/way_of_working/pull-request-template-and-guidelines.md'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/pull_request_template/hdi/github_audit_rule.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'way_of_working/audit/github/rules/base'
+
+module WayOfWorking
+  module PullRequestTemplate
+    # The namespace for plugin
+    module Hdi
+      # This rule checks for the Pull Request template.
+      class GithubAuditRule < ::WayOfWorking::Audit::Github::Rules::Base
+        def validate
+          @errors << 'No Way of Working Pull Request template found' unless pull_request_template?
+        end
+
+        private
+
+        def pull_request_template?
+          response = @client.contents(@repo_name, path: '.github/pull_request_template.md')
+          decoded_content = Base64.decode64(response.content)
+
+          decoded_content.include?('## Screenshots (optional)')
+        rescue Octokit::NotFound
+          false
+        end
+      end
+
+      ::WayOfWorking::Audit::Github::Rules::Registry.register(
+        GithubAuditRule, 'Pull Request template'
+      )
+    end
+  end
+end

data/lib/way_of_working/pull_request_template/hdi/paths.rb

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

data/lib/way_of_working/pull_request_template/hdi/plugin.rb

@@ -0,0 +1 @@
+require 'way_of_working/pull_request_template/hdi'

data/lib/way_of_working/pull_request_template/hdi/templates/.github/pull_request_template.md

@@ -0,0 +1,43 @@
+## What?
+
+{Please write a few concise sentences outlining your changes and their overall impact, avoiding overly technical language. Reference relevant issue tracker tickets, but provide a stand-alone description that doesn’t require more than a few seconds to grasp.
+
+e.g. I've added support for authentication to implement feature X of service Y. It
+includes model, table, controller and test. For more background, see ticket #JIRA-123.}
+
+## Why?
+
+{Outlining the business or engineering goals this Pull Request accomplishes is often more important than the "what". For instance, adding an environment variable default value may appear uncomplicated to many. However, if it drastically alters the usage of libraries in your application, an active-voiced explanation is needed to capture the true impact of the change.
+
+e.g. These changes complete the user login and account creation experience. See #JIRA-123 for more information.}
+
+## How?
+
+{While the Pull Request diff illustrates the "how" of your changes, it's crucial to highlight major design decisions like choosing a recursive method over a loop. Explaining your reasoning helps reviewers understand your thought process and enables a more insightful review.
+
+e.g. This includes a migration, model and controller for user authentication. I'm using Devise to do the heavy lifting. I ran Devise migrations and those are included here.}
+
+## Testing?
+
+{Including tests along with code updates is essential as it prevents merging code without tests or failing tests, which could pose risks if overlooked. It's equally important to describe how you've tested harder-to-test code, like infrastructure code, and to communicate any untested conditions or edge cases and their associated risks to the reviewer.}
+
+## Screenshots (optional)
+
+{Screenshots can significantly aid the review process, especially for UI-related changes, by offering before-and-after views. Even for backend code, a snapshot of the outcome, such as a CLI tool output, can be insightful. For infrastructure code, consider including the result of operations like a Terraform plan, preferably in a collapsible section, to avoid cluttering the comment space.
+
+Here’s how to do it in GitHub:
+```
+<details>
+  <summary>Terraform Plan</summary>
+
+  ### After running plan:
+</details>
+```
+}
+
+## Anything Else?
+
+{Consider discussing potential architectural modifications and technical debt while highlighting any challenges or optimisations you have identified.
+
+e.g. Let's consider using a 3rd party authentication provider for this, to offload MFA and other considerations as they arise and the privacy landscape evolves. AWS Cognito is a good option, so is Firebase. I'm happy to start researching this path.
+Let's also consider breaking this out into its own service. We can then re-use it or share the accounts with other apps in the future.}

data/lib/way_of_working/pull_request_template/hdi/templates/docs/way_of_working/pull-request-template-and-guidelines.md

@@ -0,0 +1,18 @@
+---
+layout: page
+---
+
+# Pull Request Template and Guidlines
+
+A Pull Request (PR) template offers multiple benefits to a development team. It standardizes the process of contributing changes, making it easier for both the author and the reviewers to understand the context of the changes. PR templates can ensure that necessary details, such as a summary of the changes, the reason for the changes (the 'why'), and any associated issue or ticket numbers, are consistently provided. This helps in maintaining a clean, organized, and searchable project history.
+
+Moreover, by setting clear expectations about the information that should be included in a PR, templates can streamline the review process, reduce the likelihood of misunderstandings, and ultimately lead to higher-quality code and a more productive team.
+
+{: .important }
+A Pull Request doesn't begin and end with the template, the tone of the request and any subsequent feedback is also very important. Alongside the [Code of Conduct](code-of-conduct.md), please read GitHub's PR communication guidlines in [How to write the perfect pull request](https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/).
+
+## Usage
+
+To add the Pull Request template to your project, use the following at the command line:
+
+    way_of_working init pull_request_template

data/lib/way_of_working/pull_request_template/hdi/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WayOfWorking
+  module PullRequestTemplate
+    module Hdi
+      VERSION = '1.0.0'
+    end
+  end
+end

data/lib/way_of_working/pull_request_template/hdi.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'way_of_working'
+require_relative 'hdi/paths'
+require 'zeitwerk'
+
+# If way_of_working-audit-github is used we can add a rule
+begin
+  require 'way_of_working/audit/github/rules/registry'
+  require_relative 'hdi/github_audit_rule'
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
+
+loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::PullRequestTemplate)
+loader.ignore("#{__dir__}/hdi/plugin.rb")
+loader.setup
+
+module WayOfWorking
+  module PullRequestTemplate
+    module Hdi
+      class Error < StandardError; end
+    end
+  end
+
+  module SubCommands
+    # This reopens the "way_of_working init" sub command
+    class Init
+      register(PullRequestTemplate::Hdi::Generators::Init, 'pull_request_template', 'pull_request_template',
+               <<~LONGDESC)
+                 Description:
+                     Installs the Pull Request template into the project
+
+                 Example:
+                     way_of_working init pull_request_template
+
+                     This will create:
+                         .github/pull_request_template.md
+               LONGDESC
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: way_of_working-pull_request_template-hdi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Gentry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: way_of_working
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+description:
+email:
+- 52189+timgentry@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".alexrc"
+- ".mega-linter.yml"
+- ".rubocop"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- code_safety.yml
+- docs/way_of_working/pull-request-template-and-guidelines.md
+- lib/way_of_working/pull_request_template/hdi.rb
+- lib/way_of_working/pull_request_template/hdi/generators/init.rb
+- lib/way_of_working/pull_request_template/hdi/github_audit_rule.rb
+- lib/way_of_working/pull_request_template/hdi/paths.rb
+- lib/way_of_working/pull_request_template/hdi/plugin.rb
+- lib/way_of_working/pull_request_template/hdi/templates/.github/pull_request_template.md
+- lib/way_of_working/pull_request_template/hdi/templates/docs/way_of_working/pull-request-template-and-guidelines.md
+- lib/way_of_working/pull_request_template/hdi/version.rb
+homepage: https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi
+  source_code_uri: https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi
+  changelog_uri: https://github.com/HealthDataInsight/way_of_working-pull_request_template-hdi/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Way of Working plugin for pull requests using the HDI template
+test_files: []