Merge 2ee435a into 3bf1552

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -11,5 +11,5 @@ Contributors guide: https://github.com/Fdawgs/ydh-fhir-authentication-service/bl
 #### Checklist
 
 -   [ ] Run `npm test`
--   [ ] Documentation has been updated if needed
+-   [ ] Documentation has been updated and adheres to the style described in [CONTRIBUTING.md](https://github.com/Fdawgs/ydh-fhir-authentication-service/blob/master/CONTRIBUTING.md#documentation-style)
 -   [ ] Commit message adheres to the [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style, following the `@commitlint/config-conventional` config

.github/workflows/codeql-analysis.yml

@@ -3,7 +3,7 @@
 #
 # You may wish to alter this file to override the set of languages analyzed,
 # or to provide custom queries or build logic.
-name: "CodeQL"
+name: CodeQL
 
 on:
     push:
@@ -25,8 +25,8 @@ jobs:
             - name: Checkout repository
               uses: actions/checkout@v2
 
-            # Initializes the CodeQL tools for scanning.
-            - name: Initialize CodeQL
+            # Initalises the CodeQL tools for scanning.
+            - name: Initalise CodeQL
               uses: github/codeql-action/init@v1
               # Override language selection by uncommenting this and choosing your languages
               # with:

.github/workflows/spellcheck.yml

@@ -0,0 +1,13 @@
+name: Spellcheck
+
+on: [push, pull_request]
+
+jobs:
+    spellcheck:
+        name: Spellcheck with Typo CI
+        runs-on: ubuntu-latest
+        steps:
+            - name: TypoCheck
+              uses: typoci/spellcheck-action@v0.3.0
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -33,6 +33,18 @@ After cloning and installing all the dependencies, there are several commands av
 
 -   `npm start` - Runs a production version. No live reload.
 
+## Documentation Style
+
+Documentation (both in markdown files and inline comments) should be written in **British English** where possible.
+
+Titles and headings should adhere to the [Associated Press (AP)](https://www.apstylebook.com/) style:
+
+-   Capitalise words with three or more letters
+-   Capitalise the first and the last word
+-   Capitalise nouns, pronouns, adjectives, verbs, adverbs, and subordinate conjunctions
+-   Lowercase articles (a, an, the), coordinating conjunctions, and prepositions
+-   Capitalise words with four or more letters (including conjunctions and prepositions)
+
 ## Pull Request Checklist
 
 Prior to submitting a pull request back to the main repository, please make sure you have completed the following steps: