From 79c25d78db69ff477cd2abe0706902046725b85d Mon Sep 17 00:00:00 2001
From: Jannis Baum <jannis.baum@gmail.com>
Date: Sat, 27 Jul 2024 13:09:56 +0200
Subject: [PATCH 1/4] docs(#134): mention convention in CONTRIBUTING.md

---
 docs/CONTRIBUTING.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index 6e8bc2eb..175cac63 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -3,7 +3,14 @@
 Contributions are very welcome! If you would like to contribute, please make
 sure you follow the steps below:
 
-- Make sure there is an issue corresponding to what you are working on
+- Make sure there is an issue corresponding to what you are working on, and name
+  your branch`issue/<issue-number>-<hyphenated-name-of-issue>`, e.g.
+
+  ```plain
+  issue/134-add-branch-naming-convention
+  ```
+
+  for issue #134 "Add branch naming convention"
 - Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
   with `#<your issue number>` as the context for all commits
 - Make sure you are not adding any merge commits to your branch

From 9fb24d957c899438fcb37740887c415f90ac6b87 Mon Sep 17 00:00:00 2001
From: Jannis Baum <jannis.baum@gmail.com>
Date: Sat, 27 Jul 2024 13:12:55 +0200
Subject: [PATCH 2/4] docs(#134): add conventional commit example

---
 docs/CONTRIBUTING.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index 175cac63..da33bc97 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -12,7 +12,12 @@ sure you follow the steps below:
 
   for issue #134 "Add branch naming convention"
 - Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
-  with `#<your issue number>` as the context for all commits
+  with `#<issue-number>` as the context for all commits, e.g.
+
+  ```plain
+  docs(#134): mention convention in CONTRIBUTING.md
+  ```
+
 - Make sure you are not adding any merge commits to your branch
 - Open a pull request, include the issue it relates to in the body, for example:
   `Closes #69`

From 379176af36c92230f3333043f410682a2700ea69 Mon Sep 17 00:00:00 2001
From: Jannis Baum <jannis.baum@gmail.com>
Date: Sat, 27 Jul 2024 13:13:59 +0200
Subject: [PATCH 3/4] docs: adjust wording

---
 docs/CONTRIBUTING.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index da33bc97..bbf48399 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -18,10 +18,10 @@ sure you follow the steps below:
   docs(#134): mention convention in CONTRIBUTING.md
   ```
 
-- Make sure you are not adding any merge commits to your branch
-- Open a pull request, include the issue it relates to in the body, for example:
-  `Closes #69`
-- Wait for a review! 🩵
+- Make sure there are no merge commits on your branch
+- Open a pull request, include the issue it relates to in the body, e.g. `Closes
+  #69`
+- Wait for a review!
 
 For more information on how to get started, read on!
 

From 2f0b731427e9556beb00f22e3f993d914dc358cb Mon Sep 17 00:00:00 2001
From: Jannis Baum <jannis.baum@gmail.com>
Date: Sat, 27 Jul 2024 13:17:51 +0200
Subject: [PATCH 4/4] docs: fix code blocks

---
 docs/CONTRIBUTING.md | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index bbf48399..7dcb8691 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -49,7 +49,9 @@ Version Manager](https://github.com/nvm-sh/nvm)** (**nvm**)
 First clone and open the **Vivify** repository, then run `yarn` to download
 Node.js dependencies
 
-    yarn
+```sh
+yarn
+```
 
 **Vivify** has a development mode that will:-
 
@@ -60,12 +62,16 @@ Node.js dependencies
 
 To run the **Vivify** server in development mode:-
 
-    yarn dev
+```sh
+yarn dev
+```
 
 Once the development server is running, you can connect as many instances as you
 like:-
 
-    yarn viv .
+```sh
+yarn viv .
+```
 
  Using `yarn viv` will connect to the development server on port 3000  
 
@@ -80,16 +86,20 @@ install path as a parameter: `./configure <install-dir>`
 
 For example:-
 
-    ./configure ~/.local/bin
+```sh
+./configure ~/.local/bin
+```
 
 Then run `make install` to build and install **Vivify**
 
-    make install
+```sh
+make install
+```
 
 Once installed you can launch **viv** by calling `viv <some-file-or-directory>`
 
 > [!TIP]  
-> Ideally the install location should be included in your $PATH variable
+> Ideally the install location should be included in your `$PATH` variable
 
 ## Troubleshooting