style: standardize bullet point formatting in markdown files

Author: PurpleBooth

CODE_OF_CONDUCT.md

@@ -17,25 +17,25 @@ welcoming, diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
--   Demonstrating empathy and kindness toward other people
--   Being respectful of differing opinions, viewpoints, and experiences
--   Giving and gracefully accepting constructive feedback
--   Accepting responsibility and apologizing to those affected by our
-    mistakes, and learning from the experience
--   Focusing on what is best not just for us as individuals, but for the
-    overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our
+  mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
 
 Examples of unacceptable behavior include:
 
--   The use of sexualized language or imagery, and sexual attention or
-    advances of any kind
--   Trolling, insulting or derogatory comments, and personal or
-    political attacks
--   Public or private harassment
--   Publishing others' private information, such as a physical or email
-    address, without their explicit permission
--   Other conduct which could reasonably be considered inappropriate in
-    a professional setting
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political
+  attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Enforcement Responsibilities
 

CONTRIBUTING.md

@@ -4,10 +4,10 @@
 
 Issues are very valuable to this project.
 
--   Ideas are a valuable source of contributions others can make
--   Problems show where this project is lacking
--   With a question you show where contributors can improve the user
-    experience
+- Ideas are a valuable source of contributions others can make
+- Problems show where this project is lacking
+- With a question you show where contributors can improve the user
+  experience
 
 Thank you for creating them.
 
@@ -38,21 +38,21 @@ the action you have taken to solve it.
 
 ### Is it of good quality
 
--   Are there unit tests
--   Are there end-to-end tests
--   Has the documentation in [docs](./README.md#docs) been updated
--   Are the lints all passing
--   Is the pull request reasonably small, or split over multiple
+- Are there unit tests
+- Are there end-to-end tests
+- Has the documentation in [docs](./README.md#docs) been updated
+- Are the lints all passing
+- Is the pull request reasonably small, or split over multiple
 
 ### Does it move this repository closer to my vision for the repository
 
 The aim of this repository is:
 
--   We aim to be easy to use
--   We aim to include lints that developers in large organisations need,
-    but not have hundreds of them
--   We aim to encourage and advocate for pair programming
--   To provide an alternative to git duet
+- We aim to be easy to use
+- We aim to include lints that developers in large organisations need,
+  but not have hundreds of them
+- We aim to encourage and advocate for pair programming
+- To provide an alternative to git duet
 
 Git duet is fantastic, but hard to use, and hard to add additional lints
 to.

README.md

@@ -263,8 +263,8 @@ it.
 
 There is a script to download the latest release:
 
-* [Windows](./installer.ps1)
-* [Linux/Mac OS](./installer.sh)
+- [Windows](./installer.ps1)
+- [Linux/Mac OS](./installer.sh)
 
 ### Completions
 
@@ -278,11 +278,12 @@ Each binary also has a command to generate completion.
 
 ### Common Tasks
 
--   [Using the pair programming part of the tool](./docs/mit.md)
--   [Using the issue number inserting part of the tool](./docs/mit-relates-to.md)
--   [Configuring lints](./docs/lints/configuring.md)
--   [Lint list](./docs/lints/index.md)
--   [Troubleshooting](./docs/troubleshooting.md)
+- [Using the pair programming part of the tool](./docs/mit.md)
+- [Using the issue number inserting part of the
+  tool](./docs/mit-relates-to.md)
+- [Configuring lints](./docs/lints/configuring.md)
+- [Lint list](./docs/lints/index.md)
+- [Troubleshooting](./docs/troubleshooting.md)
 
 ### Usage
 
@@ -292,4 +293,5 @@ Each binary also has a command to generate completion.
 - [git-mit-relates-to](./docs/binaries/git-mit-relates-to.md)
 - [Hook: mit-commit-msg](./docs/binaries/mit-commit-msg.md)
 - [Hook: mit-pre-commit](./docs/binaries/mit-pre-commit.md)
-- [Hook: mit-prepare-commit-msg](./docs/binaries/mit-prepare-commit-msg.md)
+- [Hook:
+  mit-prepare-commit-msg](./docs/binaries/mit-prepare-commit-msg.md)

docs/binaries/git-mit-config.md

@@ -90,11 +90,12 @@ You can generate completion with
 git-mit-config --completion bash
 ```
 
-Otherwise an error will be generated
+Otherwise, an error will be generated
 
 ``` shell,script(name="missing-subcommand-error",expected_exit_code=1)
 git-mit-config
 ```
+
 ``` shell,verify(script_name="missing-subcommand-error",stream=stderr)
 Error: git_mit_config::errors::unrecognised_lint_command
 

docs/binaries/git-mit-install.md

@@ -8,7 +8,7 @@ export USERPROFILE="F:\\some\\userprofile"
 git-mit-install --help
 ```
 
-```text,verify(script_name="run-help",target_os="!windows")
+``` text,verify(script_name="run-help",target_os="!windows")
 Install git-mit into a repository
 
 Usage: git-mit-install [OPTIONS]
@@ -36,7 +36,7 @@ Options:
 
 On windows the home directory is different
 
-```text,verify(script_name="run-help",target_os="windows")
+``` text,verify(script_name="run-help",target_os="windows")
 Install git-mit into a repository
 
 Usage: git-mit-install [OPTIONS]
@@ -64,6 +64,6 @@ Options:
 
 You can generate completion with
 
-```shell,script(name="generate-bash-completion",expected_exit_code=0)
+``` shell,script(name="generate-bash-completion",expected_exit_code=0)
 git-mit-install --completion bash
 ```

docs/binaries/git-mit-relates-to.md

@@ -28,7 +28,7 @@ You can generate completion with
 git-mit-relates-to --completion bash
 ```
 
-Otherwise you need an issue number
+Otherwise, you need an issue number
 
 ``` shell,script(name="missing-issue-number-error",expected_exit_code=2)
 git-mit-relates-to

docs/binaries/git-mit.md

@@ -65,11 +65,12 @@ You can generate completion with
 git-mit --completion bash
 ```
 
-Otherwise you must provide an author initial
+Otherwise, you must provide an author initial
 
 ``` shell,script(name="missing-initials-error",expected_exit_code=2)
 git-mit
 ```
+
 ``` shell,verify(script_name="missing-initials-error",stream=stderr)
 error: the following required arguments were not provided:
   <INITIALS>...

docs/binaries/mit-commit-msg.md

@@ -1,6 +1,7 @@
 # mit-commit-msg
 
-> Note: This is a hook binary, you will probably never interact with it directly
+> Note: This is a hook binary, you will probably never interact with it
+> directly
 
 Generic usage
 
@@ -31,7 +32,7 @@ You can generate completion with
 mit-commit-msg --completion bash
 ```
 
-Otherwise you need an the commit file path
+Otherwise, you need the commit file path
 
 ``` shell,script(name="missing-commit-path-error",expected_exit_code=2)
 mit-commit-msg
@@ -45,4 +46,3 @@ Usage: mit-commit-msg <COMMIT_FILE_PATH>
 
 For more information, try '--help'.
 ```
-

docs/binaries/mit-pre-commit.md

@@ -1,6 +1,7 @@
 # mit-pre-commit
 
-> Note: This is a hook binary, you will probably never interact with it directly
+> Note: This is a hook binary, you will probably never interact with it
+> directly
 
 Generic usage
 
@@ -26,7 +27,7 @@ You can generate completion with
 mit-pre-commit --completion bash
 ```
 
-Otherwise you need to have configured some authors
+Otherwise, you need to have configured some authors
 
 ``` shell,script(name="no-authors-configured-error",expected_exit_code=1)
 mit-pre-commit
@@ -41,4 +42,3 @@ Error: mit_pre_commit::errors::stale_author_error
         of whoever is coding for example: `git mit bt` or `git mit bt se`
 
 ```
-

docs/binaries/mit-prepare-commit-msg.md

@@ -1,6 +1,7 @@
 # mit-prepare-commit-msg
 
-> Note: This is a hook binary, you will probably never interact with it directly
+> Note: This is a hook binary, you will probably never interact with it
+> directly
 
 Generic usage
 
@@ -58,11 +59,12 @@ Options:
 ```
 
 You can generate completion with
+
 ``` shell,script(name="generate-mit-prepare-commit-msg-completion",expected_exit_code=0)
 mit-prepare-commit-msg --completion bash
 ```
 
-Otherwise you need an commit message path
+Otherwise, you need a commit message path
 
 ``` shell,script(name="missing-commit-path-error",expected_exit_code=2)
 mit-prepare-commit-msg
@@ -76,5 +78,3 @@ Usage: mit-prepare-commit-msg <COMMIT_MESSAGE_PATH> [COMMIT_MESSAGE_SOURCE] [COM
 
 For more information, try '--help'.
 ```
-
-