docs(contributing): add documentation style

Fdawgs · Feb 9, 2021 · ea3f3c9 · ea3f3c9
1 parent 43b1fb6
commit ea3f3c9
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -11,5 +11,5 @@ Contributors guide: https://github.com/Fdawgs/fastify-disablecache/blob/master/C
 #### 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/fastify-disablecache/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
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -25,8 +25,8 @@ jobs:
             - name: Checkout repository
               uses: actions/checkout@v2
 
-            # Initializes the CodeQL tools for scanning.
-            - name: Initialize CodeQL
+            # Initialises the CodeQL tools for scanning.
+            - name: Initialise CodeQL
               uses: github/codeql-action/init@v1
               # Override language selection by uncommenting this and choosing your languages
               # with:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -27,6 +27,18 @@ After cloning and installing all the dependencies, there are several commands av
 -   `npm run jest` - Runs Jest over all tests in src directory
 -   `npm test` - Runs `npm run lint` and `npm run jest` together
 
+## 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: