From f9e6ba497119edd4380eb0d3153ad6b1be418ada Mon Sep 17 00:00:00 2001
From: Darren Kelly <107671032+darrenvechain@users.noreply.github.com>
Date: Tue, 16 Apr 2024 15:53:40 +0100
Subject: [PATCH] chore: update contributing docs (#699)

* chore: update contributing docs

* chore: run md formatter
---
 .github/CONTRIBUTING.md          | 15 ++++++++++-----
 .github/pull_request_template.md |  7 +++++--
 README.md                        |  4 +---
 3 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 653615891..eae61fb16 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -34,10 +34,12 @@ current development landscape.
     ```bash
     make test
     ```
-    - **Note:**: Please refer to the [README](https://github.com/vechain/thor/blob/master/README.md) for information on how to start the node and interact with the
-      API.
+    - **Note:**: Please refer to the [README](https://github.com/vechain/thor/blob/master/README.md) for information on
+      how to start the node and interact with the API.
 5. Make your changes and commit them with a clear and concise commit message.
-6. Push your changes to your forked repository:
+6. Push your changes to your forked repository. **Note:** All commits must be signed with a GPG key. If you haven't
+   already set up a GPG key, please refer to the GitHub documentation
+   on [Signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account).
     ```bash
     git push origin feature/your-feature-name
     ```
@@ -60,5 +62,8 @@ current development landscape.
 
 ### Code Linting
 
-- We employ `golangci-lint` for code linting in our development process. It ensures that code adheres to established standards, and any changes that do not pass the linting checks will trigger an error during the Continuous Integration (CI) process.
-- You can run it locally by installing the `golangci-lint` binary and running `make lint` in the root directory of the repository.
+- We employ `golangci-lint` for code linting in our development process. It ensures that code adheres to established
+  standards, and any changes that do not pass the linting checks will trigger an error during the Continuous
+  Integration (CI) process.
+- You can run it locally by installing the `golangci-lint` binary and running `make lint` in the root directory of the
+  repository.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index ba23b8f55..bcff76160 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,6 +1,7 @@
 # Description
 
-Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List
+any dependencies that are required for this change.
 
 Fixes # (issue)
 
@@ -15,12 +16,14 @@ Please delete options that are not relevant.
 
 # How Has This Been Tested?
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
+list any relevant details for your test configuration
 
 - [x] Test A
 - [x] Test B
 
 **Test Configuration**:
+
 * Go Version:
 * Hardware:
 * Docker Version:
diff --git a/README.md b/README.md
index 99313baff..315a0870a 100644
--- a/README.md
+++ b/README.md
@@ -209,6 +209,4 @@ A special shout out to following projects:
 
 ## License
 
-Vechain Thor is licensed under the
-[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html), also included
-in *LICENSE* file in repository.
+Vechain Thor is licensed under the [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html), also included in *LICENSE* file in repository.