RubyGems - way_of_working-for-hdi - Versions diffs - 1.0.0 - Mend

way_of_working-for-hdi 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

checksums.yaml +7 -0
data/.alexignore +2 -0
data/.alexrc +3 -0
data/.mega-linter.yml +145 -0
data/.rubocop +1 -0
data/CHANGELOG.md +27 -0
data/CODE_OF_CONDUCT.md +133 -0
data/LICENSE.txt +21 -0
data/README.md +77 -0
data/Rakefile +16 -0
data/code_safety.yml +314 -0
data/docs/.gitignore +5 -0
data/docs/404.md +11 -0
data/docs/Gemfile +38 -0
data/docs/Gemfile.lock +293 -0
data/docs/_config.yml +90 -0
data/docs/_includes/components/sidebar.html +69 -0
data/docs/_includes/footer_custom.html +3 -0
data/docs/_sass/color_schemes/hdi-light.scss +31 -0
data/docs/_sass/custom/OneDarkJekyll.scss +203 -0
data/docs/_sass/custom/a11y-colours.scss +4 -0
data/docs/_sass/custom/color-scheme-shims.scss +66 -0
data/docs/_sass/custom/custom.scss +60 -0
data/docs/_sass/custom/setup.scss +3 -0
data/docs/decisions/0000-use-markdown-any-decision-records.md +30 -0
data/docs/decisions/0001-adoption-of-an-off-the-shelf-code-of-conduct.md +34 -0
data/docs/decisions/0002-use-megalinter-for-linting-common-file-formats.md +41 -0
data/docs/decisions/0003-use-keep-a-changelog-v1-1-as-the-format-for-changelogs.md +40 -0
data/docs/decisions/0004-end-to-end-aka-system-testing.md +41 -0
data/docs/decisions/0005-standardised-approach-to-versioning.md +27 -0
data/docs/decisions/0006-standard-approach-to-automated-accessibility-testing.md +54 -0
data/docs/decisions/0007-test-for-insensitive-and-inconsiderate-writing.md +32 -0
data/docs/decisions/0008-software-as-a-service-saas-web-analytics-solution.md +30 -0
data/docs/decisions/0009-pull-request-guidlines-and-template.md +31 -0
data/docs/decisions/README.md +7 -0
data/docs/decisions/adr-template.md +82 -0
data/docs/decisions/index.md +48 -0
data/docs/index.md +33 -0
data/docs/pa11y.json +9 -0
data/docs/way_of_working/accessibility-testing.md +29 -0
data/docs/way_of_working/changelog.md +58 -0
data/docs/way_of_working/code-linting/index.md +39 -0
data/docs/way_of_working/code-linting/linters.md +153 -0
data/docs/way_of_working/code-of-conduct.md +31 -0
data/docs/way_of_working/decision-records.md +58 -0
data/docs/way_of_working/end-to-end-testing.md +35 -0
data/docs/way_of_working/inclusive-language.md +28 -0
data/docs/way_of_working/pull-request-template-and-guidelines.md +18 -0
data/docs/way_of_working/readme-badges.md +24 -0
data/docs/way_of_working/versioning.md +25 -0
data/lib/way_of_working/for/hdi/paths.rb +20 -0
data/lib/way_of_working/for/hdi/plugin.rb +12 -0
data/lib/way_of_working/for/hdi/version.rb +9 -0
data/lib/way_of_working/for/hdi.rb +23 -0
data/lib/way_of_working/rake_tasks/generators/init.rb +47 -0
data/lib/way_of_working/rake_tasks.rb +22 -0
metadata +257 -0

data/docs/way_of_working/code-linting/linters.md ADDED Viewed

@@ -0,0 +1,153 @@
+---
+layout: page
+nav_order: 1
+parent: Code Linting
+---
+# Linters
+The following tables detail the linters that we are currently using:
+## Languages
+| Language     | Linter                                | Details                                                                         |
+|:-------------|:--------------------------------------|:--------------------------------------------------------------------------------|
+| Bash         | BASH_EXEC                             | [bash-exec](https://megalinter.io/latest/descriptors/bash_bash_exec/)           |
+| Bash         | BASH_SHELLCHECK                       | [shellcheck](https://megalinter.io/latest/descriptors/bash_shellcheck/)         |
+| Bash         | BASH_SHFMT                            | [shfmt](https://megalinter.io/latest/descriptors/bash_shfmt/)                   |
+| C            | C_CLANG_FORMAT                        | [clang-format](https://megalinter.io/latest/descriptors/c_clang_format/)        |
+| C            | C_CPPLINT                             | [cpplint](https://megalinter.io/latest/descriptors/c_cpplint/)                  |
+| C#           | CSHARP_CSHARPIER                      | [csharpier](https://megalinter.io/latest/descriptors/csharp_csharpier/)         |
+| C#           | CSHARP_DOTNET_FORMAT                  | [dotnet-format](https://megalinter.io/latest/descriptors/csharp_dotnet_format/) |
+| C#           | CSHARP_ROSLYNATOR                     | [roslynator](https://megalinter.io/latest/descriptors/csharp_roslynator/)       |
+| C++          | CPP_CLANG_FORMAT                      | [clang-format](https://megalinter.io/latest/descriptors/cpp_clang_format/)      |
+| C++          | CPP_CPPLINT                           | [cpplint](https://megalinter.io/latest/descriptors/cpp_cpplint/)                |
+| Clojure      | ~~CLOJURE_CLJSTYLE~~                  | Not Used                                                                        |
+| Clojure      | ~~CLOJURE_CLJ_KONDO~~                 | Not Used                                                                        |
+| CoffeeScript | COFFEE_COFFEELINT                     | [coffeelint](https://megalinter.io/latest/descriptors/coffee_coffeelint/)       |
+| Dart         | DART_DARTANALYZER                     | [dartanalyzer](https://megalinter.io/latest/descriptors/dart_dartanalyzer/)     |
+| Go           | GO_GOLANGCI_LINT                      | [golangci-lint](https://megalinter.io/latest/descriptors/go_golangci_lint/)     |
+| Go           | GO_REVIVE                             | [revive](https://megalinter.io/latest/descriptors/go_revive/)                   |
+| Groovy       | ~~GROOVY_NPM_GROOVY_LINT~~            | Not Used                                                                        |
+| Java         | JAVA_CHECKSTYLE                       | [checkstyle](https://megalinter.io/latest/descriptors/java_checkstyle/)         |
+| Java         | JAVA_PMD                              | [pmd](https://megalinter.io/latest/descriptors/java_pmd/)                       |
+| JavaScript   | JAVASCRIPT_ES                         | [eslint](https://megalinter.io/latest/descriptors/javascript_eslint/)           |
+| JavaScript   | ~~JAVASCRIPT_PRETTIER~~               | Not Used                                                                        |
+| JavaScript   | JAVASCRIPT_STANDARD                   | [standard](https://megalinter.io/latest/descriptors/javascript_standard/)       |
+| JSX          | JSX_ESLINT                            | [eslint](https://megalinter.io/latest/descriptors/jsx_eslint/)                  |
+| Kotlin       | KOTLIN_DETEKT                         | [detekt](https://megalinter.io/latest/descriptors/kotlin_detekt/)               |
+| Kotlin       | KOTLIN_KTLINT                         | [ktlint](https://megalinter.io/latest/descriptors/kotlin_ktlint/)               |
+| Lua          | ~~LUA_LUACHECK~~                      | Not Used                                                                        |
+| Lua          | ~~LUA_SELENE~~                        | Not Used                                                                        |
+| Lua          | ~~LUA_STYLUA~~                        | Not Used                                                                        |
+| Makefile     | MAKEFILE_CHECKMAKE                    | [checkmake](https://megalinter.io/latest/descriptors/makefile_checkmake/)       |
+| Perl         | ~~PERL_PERLCRITIC~~                   | Not Used                                                                        |
+| PHP          | ~~PHP_PHPCS~~                         | Not Used                                                                        |
+| PHP          | ~~PHP_PHPCSFIXER~~                    | Not Used                                                                        |
+| PHP          | ~~PHP_PHPLINT~~                       | Not Used                                                                        |
+| PHP          | ~~PHP_PHPSTAN~~                       | Not Used                                                                        |
+| PHP          | ~~PHP_PSALM~~                         | Not Used                                                                        |
+| Powershell   | ~~POWERSHELL_POWERSHELL~~             | Not Used                                                                        |
+| Powershell   | ~~POWERSHELL_POWERSHELL_FORMATTER~~   | Not Used                                                                        |
+| Python       | PYTHON_BANDIT                         | [bandit](https://megalinter.io/latest/descriptors/python_bandit/)               |
+| Python       | PYTHON_BLACK                          | [black](https://megalinter.io/latest/descriptors/python_black/)                 |
+| Python       | PYTHON_FLAKE8                         | [flake8](https://megalinter.io/latest/descriptors/python_flake8/)               |
+| Python       | PYTHON_ISORT                          | [isort](https://megalinter.io/latest/descriptors/python_isort/)                 |
+| Python       | PYTHON_MYPY                           | [mypy](https://megalinter.io/latest/descriptors/python_mypy/)                   |
+| Python       | PYTHON_PYLINT                         | [pylint](https://megalinter.io/latest/descriptors/python_pylint/)               |
+| Python       | PYTHON_PYRIGHT                        | [pyright](https://megalinter.io/latest/descriptors/python_pyright/)             |
+| Python       | PYTHON_RUFF                           | [ruff](https://megalinter.io/latest/descriptors/python_ruff/)                   |
+| R            | R_LINTR                               | [lintr](https://megalinter.io/latest/descriptors/r_lintr/)                      |
+| Raku         | ~~RAKU_RAKU~~                         | Not Used                                                                        |
+| Ruby         | ~~RUBY_RUBOCOP~~                      | Not Used (RuboCop is used directly)                                             |
+| Rust         | RUST_CLIPPY                           | [clippy](https://megalinter.io/latest/descriptors/rust_clippy/)                 |
+| Salesforce   | ~~SALESFORCE_LIGHTNING_FLOW_SCANNER~~ | Not Used                                                                        |
+| Salesforce   | ~~SALESFORCE_SFDX_SCANNER_APEX~~      | Not Used                                                                        |
+| Salesforce   | ~~SALESFORCE_SFDX_SCANNER_AURA~~      | Not Used                                                                        |
+| Salesforce   | ~~SALESFORCE_SFDX_SCANNER_LWC~~       | Not Used                                                                        |
+| Scala        | SCALA_SCALAFIX                        | [scalafix](https://megalinter.io/latest/descriptors/scala_scalafix/)            |
+| SQL          | SQL_SQLFLUFF                          | [sqlfluff](https://megalinter.io/latest/descriptors/sql_sqlfluff/)              |
+| SQL          | SQL_TSQLLINT                          | [tsqllint](https://megalinter.io/latest/descriptors/sql_tsqllint/)              |
+| Swift        | SWIFT_SWIFTLINT                       | [swiftlint](https://megalinter.io/latest/descriptors/swift_swiftlint/)          |
+| TSX          | TSX_ESLINT                            | [eslint](https://megalinter.io/latest/descriptors/tsx_eslint/)                  |
+| TypeScript   | TYPESCRIPT_ES                         | [eslint](https://megalinter.io/latest/descriptors/typescript_eslint/)           |
+| TypeScript   | ~~TYPESCRIPT_PRETTIER~~               | Not Used                                                                        |
+| TypeScript   | TYPESCRIPT_STANDARD                   | [ts-standard](https://megalinter.io/latest/descriptors/typescript_ts_standard/) |
+| VB.Net       | ~~VBDOTNET_DOTNET_FORMAT~~            | Not Used                                                                        |
+## Formats
+| Format           | Linter                            | Details                                                                                                 |
+|:-----------------|:----------------------------------|:--------------------------------------------------------------------------------------------------------|
+| CSS              | CSS_STYLELINT                     | [stylelint](https://megalinter.io/latest/descriptors/css_stylelint/)                                    |
+| ENV              | ENV_DOTENV_LINTER                 | [dotenv-linter](https://megalinter.io/latest/descriptors/env_dotenv_linter/)                            |
+| GraphQL          | ~~GRAPHQL_GRAPHQL_SCHEMA_LINTER~~ | Not Used                                                                                                |
+| HTML             | ~~HTML_DJLINT~~                   | Not Used (Refuses to see config file)                                                                   |
+| HTML             | HTML_HTMLHINT                     | [htmlhint](https://megalinter.io/latest/descriptors/html_htmlhint/)                                     |
+| JSON             | JSON_ESLINT_PLUGIN_JSONC          | [eslint-plugin-jsonc](https://megalinter.io/latest/descriptors/json_eslint_plugin_jsonc/)               |
+| JSON             | JSON_JSONLINT                     | [jsonlint](https://megalinter.io/latest/descriptors/json_jsonlint/)                                     |
+| JSON             | JSON_NPM_PACKAGE_JSON_LINT        | [npm-package-json-lint](https://megalinter.io/latest/descriptors/json_npm_package_json_lint/)           |
+| JSON             | ~~JSON_PRETTIER~~                 | Not Used                                                                                                |
+| JSON             | JSON_V8R                          | [v8r](https://megalinter.io/latest/descriptors/json_v8r/)                                               |
+| LaTeX            | ~~LATEX_CHKTEX~~                  | Not Used                                                                                                |
+| Markdown         | MARKDOWN_MARKDOWNLINT             | [markdownlint](https://megalinter.io/latest/descriptors/markdown_markdownlint/)                         |
+| Markdown         | MARKDOWN_MARKDOWN_LINK_CHECK      | [markdown-link-check](https://megalinter.io/latest/descriptors/markdown_markdown_link_check/)           |
+| Markdown         | MARKDOWN_MARKDOWN_TABLE_FORMATTER | [markdown-table-formatter](https://megalinter.io/latest/descriptors/markdown_markdown_table_formatter/) |
+| Markdown         | MARKDOWN_REMARK_LINT              | [remark-lint](https://megalinter.io/latest/descriptors/markdown_remark_lint/)                           |
+| Protocol Buffers | ~~PROTOBUF_PROTOLINT~~            | Not Used                                                                                                |
+| reStructuredText | ~~RST_RSTCHECK~~                  | Not Used                                                                                                |
+| reStructuredText | ~~RST_RSTFMT~~                    | Not Used                                                                                                |
+| reStructuredText | ~~RST_RST_LINT~~                  | Not Used                                                                                                |
+| XML              | XML_XMLLINT                       | [xmllint](https://megalinter.io/latest/descriptors/xml_xmllint/)                                        |
+| YAML             | ~~YAML_PRETTIER~~                 | Not Used                                                                                                |
+| YAML             | YAML_V8R                          | [v8r](https://megalinter.io/latest/descriptors/yaml_v8r/)                                               |
+| YAML             | YAML_YAMLLINT                     | [yamllint](https://megalinter.io/latest/descriptors/yaml_yamllint/)                                     |
+## Tooling formats
+| Tooling format | Linter                            | Details                                                                                             |
+|:---------------|:----------------------------------|:----------------------------------------------------------------------------------------------------|
+| GitHub Action  | ACTION_ACTIONLINT                 | [actionlint](https://megalinter.io/latest/descriptors/action_actionlint/)                           |
+| Ansible        | ANSIBLE_ANSIBLE_LINT              | [ansible-lint](https://megalinter.io/latest/descriptors/ansible_ansible_lint/)                      |
+| Api            | API_SPECTRAL                      | [spectral](https://megalinter.io/latest/descriptors/api_spectral/)                                  |
+| ARM Templates  | ARM_ARM_TTK                       | [arm-ttk](https://megalinter.io/latest/descriptors/arm_arm_ttk/)                                    |
+| Bicep          | ~~BICEP_BICEP_LINTER~~            | Not Used                                                                                            |
+| CloudFormation | CLOUDFORMATION_CFN_LINT           | [cfn-lint](https://megalinter.io/latest/descriptors/cloudformation_cfn_lint/)                       |
+| Dockerfile     | DOCKERFILE_HADOLINT               | [hadolint](https://megalinter.io/latest/descriptors/dockerfile_hadolint/)                           |
+| EditorConfig   | EDITORCONFIG_EDITORCONFIG_CHECKER | [editorconfig-checker](https://megalinter.io/latest/descriptors/editorconfig_editorconfig_checker/) |
+| Gherkin        | ~~GHERKIN_GHERKIN_LINT~~          | Not Used                                                                                            |
+| Kubernetes     | KUBERNETES_HELM                   | [helm](https://megalinter.io/latest/descriptors/kubernetes_helm/)                                   |
+| Kubernetes     | KUBERNETES_KUBECONFORM            | [kubeconform](https://megalinter.io/latest/descriptors/kubernetes_kubeconform/)                     |
+| Kubernetes     | KUBERNETES_KUBESCAPE              | [kubescape](https://megalinter.io/latest/descriptors/kubernetes_kubescape/)                         |
+| Puppet         | PUPPET_PUPPET_LINT                | [puppet-lint](https://megalinter.io/latest/descriptors/puppet_puppet_lint/)                         |
+| Snakemake      | ~~SNAKEMAKE_LINT~~                | Not Used                                                                                            |
+| Snakemake      | ~~SNAKEMAKE_SNAKEFMT~~            | Not Used                                                                                            |
+| Tekton         | ~~TEKTON_TEKTON_LINT~~            | Not Used                                                                                            |
+| Terraform      | TERRAFORM_TERRAFORM_FMT           | [terraform-fmt](https://megalinter.io/latest/descriptors/terraform_terraform_fmt/)                  |
+| Terraform      | TERRAFORM_TERRAGRUNT              | [terragrunt](https://megalinter.io/latest/descriptors/terraform_terragrunt/)                        |
+| Terraform      | TERRAFORM_TERRASCAN               | [terrascan](https://megalinter.io/latest/descriptors/terraform_terrascan/)                          |
+| Terraform      | TERRAFORM_TFLINT                  | [tflint](https://megalinter.io/latest/descriptors/terraform_tflint/)                                |
+## Other
+| Other      | Linter                | Details                                                                       |
+|:-----------|:----------------------|:------------------------------------------------------------------------------|
+| Copypaste  | COPYPASTE_JSCPD       | [jscpd](https://megalinter.io/latest/descriptors/copypaste_jscpd/)            |
+| Repository | REPOSITORY_CHECKOV    | [checkov](https://megalinter.io/latest/descriptors/repository_checkov/)       |
+| Repository | REPOSITORY_DEVSKIM    | [devskim](https://megalinter.io/latest/descriptors/repository_devskim/)       |
+| Repository | REPOSITORY_DUSTILOCK  | [dustilock](https://megalinter.io/latest/descriptors/repository_dustilock/)   |
+| Repository | REPOSITORY_GITLEAKS   | [gitleaks](https://megalinter.io/latest/descriptors/repository_gitleaks/)     |
+| Repository | REPOSITORY_GIT_DIFF   | [git_diff](https://megalinter.io/latest/descriptors/repository_git_diff/)     |
+| Repository | REPOSITORY_GRYPE      | [grype](https://megalinter.io/latest/descriptors/repository_grype/)           |
+| Repository | REPOSITORY_KICS       | [kics](https://megalinter.io/latest/descriptors/repository_kics/)             |
+| Repository | REPOSITORY_LS_LINT    | [ls-lint](https://megalinter.io/latest/descriptors/repository_ls_lint/)       |
+| Repository | REPOSITORY_SECRETLINT | [secretlint](https://megalinter.io/latest/descriptors/repository_secretlint/) |
+| Repository | REPOSITORY_SEMGREP    | [semgrep](https://megalinter.io/latest/descriptors/repository_semgrep/)       |
+| Repository | REPOSITORY_SYFT       | [syft](https://megalinter.io/latest/descriptors/repository_syft/)             |
+| Repository | REPOSITORY_TRIVY      | [trivy](https://megalinter.io/latest/descriptors/repository_trivy/)           |
+| Repository | REPOSITORY_TRIVY_SBOM | [trivy-sbom](https://megalinter.io/latest/descriptors/repository_trivy_sbom/) |
+| Repository | REPOSITORY_TRUFFLEHOG | [trufflehog](https://megalinter.io/latest/descriptors/repository_trufflehog/) |
+| Spelling   | ~~SPELL_CSPELL~~      | Not Used                                                                      |
+| Spelling   | SPELL_LYCHEE          | [lychee](https://megalinter.io/latest/descriptors/spell_lychee/)              |
+| Spelling   | SPELL_PROSELINT       | [proselint](https://megalinter.io/latest/descriptors/spell_proselint/)        |
+| Spelling   | SPELL_VALE            | [vale](https://megalinter.io/latest/descriptors/spell_vale/)                  |

data/docs/way_of_working/code-of-conduct.md ADDED Viewed

@@ -0,0 +1,31 @@
+---
+layout: page
+---
+# Code of Conduct
+We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct v2.1
+Using the Contributor Covenant Code of Conduct benefits any community or project by setting clear expectations for acceptable behaviour and creating a safer and more inclusive environment for everyone involved.
+The Code of Conduct establishes guidelines for respectful communication and conduct and consequences for inappropriate behaviour. By adhering to these guidelines, community members can build trust and mutual respect, which fosters a more collaborative and productive environment.
+The Contributor Covenant is specifically designed to promote diversity and inclusion within communities and projects. It includes provisions to prevent discrimination and harassment based on factors such as race, gender, sexual orientation, and ability. By adopting and enforcing the Code of Conduct, communities can create a more welcoming and supportive environment for underrepresented groups.
+In addition to promoting a positive and inclusive environment, the Contributor Covenant can help prevent conflicts and misunderstandings by providing a clear set of expectations for behaviour, reducing the likelihood of interpersonal conflicts and creating a more harmonious community.
+Projects and communities can establish a strong foundation for healthy collaboration and growth using the Contributor Covenant Code of Conduct.
+{: .important }
+Adopting the Contributor Covenant Code of Conduct involves more than only adding a `CODE_OF_CONDUCT.md` file to the root of your project.
+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 with your team.
+## Usage
+### Adding the Code of Conduct to your project
+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.
+{: .note }
+We recommend that you use the HDI code of conduct email address as the contact method.

data/docs/way_of_working/decision-records.md ADDED Viewed

@@ -0,0 +1,58 @@
+---
+has_children: true
+---
+# Decision Records
+We use [Markdown Any Decision Records (MADR)](https://adr.github.io/madr/) version 3.0.0.
+In general, projects will follow the [Way of Working](https://github.com/HealthDataInsight/way_of_working) and so decisions captured within individual projects will generally cover decisions that:
+- are not already covered in the Way of Working
+- are covered in the Way of Working, but have specific implementation details which need to be captured
+- diverge from the guidance in the Way of Working
+You can read about the general approach to capturing decisions on the [GDS Way page on Architecture Decisions](https://gds-way.cloudapps.digital/standards/architecture-decisions.html) and specifics about MADR are available at <https://adr.github.io/madr/>.
+Proposing and reviewing decisions requires an understanding of GitHub and [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+## Usage
+### Adding Markdown Any Decision Records to your project
+To add the MADR v3.0.0 framework to your project, run the following at the command line:
+```bash
+way_of_working init decision_record
+```
+### Create a new decision record
+#### Manual approach
+1. Copy `docs/decisions/adr-template.md` to `docs/decisions/NNNN-title-with-dashes.md`, where `NNNN` indicates the next number in sequence.
+2. Edit `NNNN-title-with-dashes.md`.
+Note you can also use [other patterns for the directory format](https://github.com/joelparkerhenderson/architecture_decision_record#adr-file-name-conventions).
+As a consequence, some existing tooling might not be applicable.
+The filenames are following the pattern `NNNN-title-with-dashes.md`, where
+- `NNNN` is a consecutive number and we assume that there won't be more than 9,999 ADRs in one repository.
+- the title is stored using dashes and lowercase, because [adr-tools] also does that.
+- the suffix is `.md`, because it is a [Markdown](https://github.github.com/gfm/) file.
+Decisions are placed in the subfolder `decisions/` to keep them close to the documentation but also separate the decisions from other documentation.
+#### Automatic approach
+To create a new decision record, run:
+```bash
+way_of_working new decision_record [NAME]
+```
+Where `[NAME]` is the title of your decision record, for example:
+```bash
+way_of_working new decision_record "Use Markdown Any Decision Records"
+```

data/docs/way_of_working/end-to-end-testing.md ADDED Viewed

@@ -0,0 +1,35 @@
+---
+layout: page
+---
+# End-to-End Testing
+We have adopted [Cypress](https://www.cypress.io) for end-to-end web application testing.
+End-to-end testing (also known as system testing) is essential to the software development lifecycle, especially for web applications. End-to-end tests help ensure that all the application components work together as intended, from the front-end user interface to the server-side back-end functionality. In addition, end-to-end tests can help catch issues that may not be apparent in unit or integration tests by testing the entire application flow.
+One of the primary benefits of end-to-end testing is that it helps improve the overall quality of the web application. By testing the entire application flow, developers can identify and fix issues early on before they become significant problems that impact the user experience. End-to-end tests can also help ensure that new features or changes to existing features do not introduce regressions that negatively affect the user experience.
+End-to-end testing can also help reduce the risk of downtime or data loss. End-to-end tests can help prevent costly downtime and data loss by catching issues before they impact production environments. Additionally, end-to-end tests can help ensure that the application is working as expected after updates or changes to the infrastructure, such as deploying to a new server or upgrading to a recent version of a framework or library.
+Overall, writing end-to-end tests for web applications is critical to ensuring the application's quality and reliability. By testing the entire application flow, developers can catch issues early on and reduce the risk of downtime or data loss. Additionally, end-to-end tests can help improve the overall user experience by ensuring the application works as expected.
+## Usage
+### Adding Cypress to your Rails project
+In order to not delay the decision to adopt Cypress, the automated Rails initialisation tooling will be added later. For now, please follow the [cypress-rails](https://github.com/testdouble/cypress-rails) instructions.
+For information on using cypress, visit <https://github.com/testdouble/cypress-rails#usage>.
+### Adding Cypress to other projects
+To add Cypress to non-Rails projects, please follow the official instructions on [installing Cypress](https://docs.cypress.io/guides/getting-started/installing-cypress).
+### Writing tests
+The Cypress documentation is excellent, but here are a few good starting points:
+* [Writing Your First End-to-End Test](https://docs.cypress.io/guides/end-to-end-testing/writing-your-first-end-to-end-test)
+* [Introduction to Cypress](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress)
+* [Best Practices](https://docs.cypress.io/guides/references/best-practices)

data/docs/way_of_working/inclusive-language.md ADDED Viewed

@@ -0,0 +1,28 @@
+---
+layout: page
+---
+# Inclusive Language
+We have adopted [alex](https://alexjs.com) for automated testing of 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. When we use insensitive or offensive language, we undermine our ability to connect with others and build trust.
+Therefore, it is essential to be mindful of the impact of our words and to choose language that is respectful, inclusive, and considerate of others. Doing so can create a more welcoming and inclusive environment for everyone, fostering greater understanding, empathy, and cooperation.
+To quote from the alex README:
+> No automated tool can replace studying inclusive communication and listening to the lived experiences of others. **An error from alex can be an invitation to learn more**.
+{: .important }
+Please take the opportunity to read some of the [further reading](https://github.com/get-alex/alex#further-reading) they reference and click on the links against individual warnings when they appear.
+## Usage
+To add alex to your project, run the following at the command line:
+    way_of_working init inclusive_language
+to run alex in your project, run:
+    way_of_working exec inclusive_language

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

@@ -0,0 +1,18 @@
+---
+layout: page
+---
+# Pull Request Template and Guidelines
+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 guidelines 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/docs/way_of_working/readme-badges.md ADDED Viewed

@@ -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.
+![HDI Way of Working Badge](https://img.shields.io/badge/HDI_Way_of_Working-v1.0.0-%238169e3?labelColor=black)
+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/docs/way_of_working/versioning.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+layout: page
+---
+# Versioning
+We have adopted [Semantic Versioning](https://semver.org) as our versioning system.
+Semantic Versioning, or "semver" for short, is a versioning system developers use to communicate effectively about the changes made to their software. Semver consists of three numbers separated by dots, with each number representing a different aspect of the software's version. The first number indicates a major release, the second number indicates a minor release, and the third number indicates a patch release.
+From the website:
+> Given a version number MAJOR.MINOR.PATCH, increment the:
+>
+>   1. MAJOR version when you make incompatible API changes
+>   2. MINOR version when you add functionality in a backwards compatible manner
+>   3. PATCH version when you make backwards compatible bug fixes
+>
+> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
+Following the semver format, developers can tell users and other developers what has changed in each release and whether the changes are significant enough to require an update. This helps users and other developers make informed decisions about whether to update their software and also helps to prevent confusion and errors caused by incompatible software versions.
+Using the same versioning system across different projects allows developers to compare and understand the differences between software releases quickly. Additionally, semver provides a framework for planning and organizing future development, as developers can use the version numbers to indicate their plans for future releases.
+Semantic versioning is a good practice for developers because it improves communication and consistency, helps users and other developers make informed decisions about updating their software, and provides a framework for planning and organizing future development.

data/lib/way_of_working/for/hdi/paths.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'pathname'
+module WayOfWorking
+  module For
+    # 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', 'for', 'hdi', 'templates')
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/for/hdi/plugin.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require 'way_of_working/for/hdi'
+# Add any plug specific code here
+module WayOfWorking
+  module For
+    module Hdi
+      # This makes zeitwerk happy, which makes us happy too
+      module Plugin
+      end
+    end
+  end
+end

data/lib/way_of_working/for/hdi/version.rb ADDED Viewed

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

data/lib/way_of_working/for/hdi.rb ADDED Viewed

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'way_of_working'
+require_relative 'hdi/paths'
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::For)
+loader.setup
+# Require "internal" plugin(s) here
+require 'way_of_working/rake_tasks'
+module WayOfWorking
+  module For
+    module Hdi
+      class Error < StandardError; end
+    end
+  end
+  # Configure HDI-specific settings
+  Configuration.organisation_abbreviation = 'HDI'
+  Configuration.organisation_gem_version = For::Hdi::VERSION
+end

data/lib/way_of_working/rake_tasks/generators/init.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+module WayOfWorking
+  module RakeTasks
+    module Generators
+      # This generator installs way of working rake tasks into this project
+      class Init < Thor::Group
+        include Thor::Actions
+        RAKEFILE_FILENAME = 'Rakefile'
+        RAILS_LOC = %r{require_relative ["']config/application["']\n}
+        BUNDLER_LOC = %r{require ["']bundler/gem_tasks["']\n}
+        def add_to_rakefile
+          case rakefile_type
+          when :rails
+            inject_into_file RAKEFILE_FILENAME,
+                             "require 'way_of_working/tasks' if Rails.env.development? " \
+                             "|| Rails.env.test?\n",
+                             after: RAILS_LOC
+          when :bundler
+            inject_into_file RAKEFILE_FILENAME,
+                             "require 'way_of_working/tasks'\n",
+                             after: BUNDLER_LOC
+          when :none
+            create_file RAKEFILE_FILENAME, "\nrequire 'way_of_working/tasks'\n"
+          else
+            append_to_file RAKEFILE_FILENAME, "\nrequire 'way_of_working/tasks'\n"
+          end
+        end
+        private
+        def rakefile_type
+          content = File.read(File.expand_path(RAKEFILE_FILENAME, destination_root))
+          return :rails if content.match?(RAILS_LOC)
+          return :bundler if content.match?(BUNDLER_LOC)
+          :other
+        rescue Errno::ENOENT
+          :none
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/rake_tasks.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative 'rake_tasks/generators/init'
+module WayOfWorking
+  module SubCommands
+    # This reopens the "way_of_working init" sub command
+    class Init
+      register(WayOfWorking::RakeTasks::Generators::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
+  end
+end