From ad51bfde2831c42da9438b7cc907ca9c3fb12cb6 Mon Sep 17 00:00:00 2001 From: Jacob Woffenden Date: Tue, 20 Aug 2024 15:15:08 +0100 Subject: [PATCH 1/2] test --- .github/linters/.textlintrc | 8 ++++++++ README.md | 4 ++++ 2 files changed, 12 insertions(+) create mode 100644 .github/linters/.textlintrc diff --git a/.github/linters/.textlintrc b/.github/linters/.textlintrc new file mode 100644 index 0000000..5070696 --- /dev/null +++ b/.github/linters/.textlintrc @@ -0,0 +1,8 @@ +{ + "filters": { + "comments": true + }, + "rules": { + "terminology": true + } +} diff --git a/README.md b/README.md index d9d564d..b13ad85 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,12 @@ The repository comes with the following preset files: Once you've created your repository using this template, perform the following steps: + + ### Update README + + Edit this README.md file to document your project accurately. Take the time to create a clear, engaging, and informative README.md file. Include information like what your project does, how to install and run it, how to contribute, and any other pertinent details. ### Update repository description From 6991fd8d7d787e7de0921c42ab52dcc51ddd2664 Mon Sep 17 00:00:00 2001 From: Jacob Woffenden Date: Tue, 20 Aug 2024 15:18:45 +0100 Subject: [PATCH 2/2] yoink --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b13ad85..54a9652 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,11 @@ Please read and understand these standards thoroughly and enable them when you f ### Modify the GitHub Repository Standards Badge -Once you've ensured that all the [GitHub Repository Standards](https://operations-engineering.service.justice.gov.uk/documentation/services/repository-standards.html) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README file. +Once you've ensured that all the [GitHub Repository Standards](https://operations-engineering.service.justice.gov.uk/documentation/services/repository-standards.html) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README.md file. The badge demonstrates that your repository is compliant with MoJ's standards. Please follow these [instructions](https://operations-engineering.service.justice.gov.uk/documentation/runbooks/services/add-repo-badge.html) to modify the badge URL to reflect the status of your repository correctly. -**Please note** the badge will not function correctly if your repository is internal or private. In this case, you may remove the badge from your README. +**Please note** the badge will not function correctly if your repository is internal or private. In this case, you may remove the badge from your README.md. ### Manage Outside Collaborators