way_of_working-code_linting-hdi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63283e1c6860b1a7b4d02fce81b3ed85baaaca417ab068f2e52a92431e228729
+  data.tar.gz: 41c58a76977acbf970fccd0e812c3edda789e3987d72b0e4e74903aa8f98a8ad
+SHA512:
+  metadata.gz: f004091c09472b59b64833cffb2398c5f9c6f560043442a5bfeb85e05fa7043f1f478d8ac2dcb19235cf47211e05b40c8b952e031dcf7b7c726651ae238949fd
+  data.tar.gz: 6a15f2783ac0080362bdf2026d13968115ef39b58a6f88f13785c3be556c0d49876557d27041dbfe297194d9d064d786e4cb8a4f7df8b8360311f63412c7a4a3

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,20 @@
+# 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-27
+
+### Added
+
+- Added a document command to update the list of used and available linters
+- Added Swiftlint build phase to Xcode projects
+- Added MegaLinter for linting common file formats with generator command and rake task
+- Added a GitHub audit rule to check that linting is used and configured correctly
+
+[unreleased]: https://github.com/HealthDataInsight/way_of_working-code_linting-hdi/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/HealthDataInsight/way_of_working-code_linting-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,58 @@
+# WayOfWorking::CodeLinting::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 -->
+
+We use [MegaLinter](https://megalinter.io/) for the majority of our code lining, currently with separate Ruby testing with RuboCop.
+
+Code linters like MegaLinter benefit developers and teams because they help improve code quality, reduce errors and inconsistencies, and streamline development. Linters analyze source code for common issues, such as syntax errors, undefined variables, and unused code, and provide suggestions and feedback for improvement.
+
+## 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 [MegaLinter](https://megalinter.io/) to your project, run the following at the command line:
+
+```bash
+way_of_working init code_linting
+```
+
+to run MegaLinter in your project, run:
+
+```bash
+way_of_working exec code_linting
+```
+
+## 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-code_linting-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-code_linting-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-code_linting-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-code_linting-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,186 @@
+---
+file safety:
+  ".alexrc":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  ".github/linters/.markdown-link-check.json":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  ".github/linters/rubocop_defaults.yml":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  ".github/workflows/inclusive-language.yml":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  ".github/workflows/main.yml":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  ".github/workflows/mega-linter.yml":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  ".gitignore":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  ".mega-linter.yml":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  ".rubocop":
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  CHANGELOG.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  Gemfile:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  Gemfile.lock:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  LICENSE.txt:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  README.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  Rakefile:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  bin/console:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  bin/setup:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  docs/way_of_working/code-linting/index.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  docs/way_of_working/code-linting/linters.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/generators/document_linters.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/generators/exec.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/generators/init.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/generators/init_linters.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/github_audit_rule.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/paths.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  lib/way_of_working/code_linting/hdi/plugin.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/supported_linter.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/.github/linters/.markdown-link-check.json:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/.github/linters/rubocop_defaults.yml:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/.github/workflows/mega-linter.yml:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/.mega-linter.yml:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/.rubocop:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/docs/way_of_working/code-linting/index.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/templates/docs/way_of_working/code-linting/linters.md.tt:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  lib/way_of_working/code_linting/hdi/version.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/resources/XcodeApp.xcodeproj/project.pbxproj:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/test_helper.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  test/way_of_working/audit_github_stub_classes.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/way_of_working/code_linting/hdi/generators/document_linters_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/way_of_working/code_linting/hdi/generators/exec_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/way_of_working/code_linting/hdi/generators/init_linters_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/way_of_working/code_linting/hdi/github_audit_rule_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/way_of_working/code_linting/hdi/zeitwerk_loader_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac
+  test/way_of_working/code_linting/hdi_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: b89ef4afd67d02b6f6ff323bb9accde2dcf2686d
+  way_of_working-code_linting-hdi.gemspec:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 0c7aeda9a9a90b16cea0f1921e29b21d4f27e5ac

data/docs/way_of_working/code-linting/index.md

@@ -0,0 +1,39 @@
+---
+has_children: true
+layout: page
+---
+
+# Code Linting
+
+We use [MegaLinter](https://megalinter.io/) for the majority of our code lining, currently with separate Ruby testing with RuboCop.
+
+Code linters like MegaLinter benefit developers and teams because they help improve code quality, reduce errors and inconsistencies, and streamline development. Linters analyze source code for common issues, such as syntax errors, undefined variables, and unused code, and provide suggestions and feedback for improvement.
+
+Using a linter like MegaLinter, developers can catch and fix errors early in the development process, saving time and effort in the long run.
+The linter also provides consistency in the codebase, helping to prevent errors caused by different team members using different styles or approaches, which can be especially valuable for large projects with many contributors or where you want staff to be able to switch between projects more efficiently.
+
+MegaLinter is a particularly powerful linter because it supports multiple programming languages, making it a one-stop shop for developers working on projects with various languages.
+
+{: .note }
+We have chosen not to use the version of [RuboCop](https://rubocop.org) packaged in MegaLinter because it can't support our use of Minitest and Rails "cops". But by using our CLI command to run linting, as documented below, both RuboCop and MegaLinter will be executed against your code.
+
+When you add the Way of Working linter to your project, it will copy our per-language organisational code styles (where they differ from defaults) into `.github/linters` and will copy the GitHub Actions workflow files into `.github/workflow`, so that linting automatically runs when you commit to GitHub.
+
+If you add the Way of Working linter to your Xcode project, it will automatically add a Swiftlint build phase to the project config file.
+
+{: .important }
+If you disagree with any of the linters or linting styles that they apply, please fork the repository and create a pull request with your desired changes. The current coding standards are only intended as a starting point. A Full list of the linters we are currently using can be found [here](linters.md).
+
+## Usage
+
+To add [MegaLinter](https://megalinter.io/) and [RuboCop](https://rubocop.org) to your project, run the following at the command line:
+
+    way_of_working init code_linting
+
+to run MegaLinter in your project, run:
+
+    way_of_working exec code_linting
+
+to document your use of MegaLinter in your project, run:
+
+    way_of_working exec document