From 6845aae0eec07c279b250d88682154533e1e01e2 Mon Sep 17 00:00:00 2001
From: Pritish Budhiraja <1805317@kiit.ac.in>
Date: Wed, 6 Dec 2023 13:09:10 +0530
Subject: [PATCH] docs: README.md changes

---
 README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

diff --git a/README.md b/README.md
index 29d5b0d3f..c93b1e70f 100644
--- a/README.md
+++ b/README.md
@@ -267,10 +267,82 @@ curl https://raw.githubusercontent.com/juspay/hyperswitch-control-center/main/aw
 
 ---
 
+## Changelog
+
+For a detailed list of changes made in each version, please refer to the [Changelog](./CHANGELOG.md) file.
+
+---
+
 ## Contributing
 
 We welcome contributions from the community! If you would like to contribute to Hyperswitch, please follow our contribution guidelines.
 
+### Commit Conventions
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for our commit messages. Each commit message should have a structured format:
+
+`<type>(<subject>): <description>`
+
+The commit message should begin with one of the following keywords followed by a colon: 'feat', 'fix', 'chore', 'refactor', 'docs', 'test' or 'style'. For example, it should be formatted like this: `feat: <subject> - <description>`
+
+### Signing Commits
+
+All commits should be signed to verify the authenticity of contributors. Follow the steps below to sign your commits:
+
+1.  Generate a GPG key if you haven't already:
+
+    ```bash
+    gpg --gen-key
+    ```
+
+2.  List your GPG keys and copy the GPG key ID::
+
+    ```bash
+    gpg --list-secret-keys --keyid-format LONG
+    ```
+
+    #### Identify the GPG key you want to add to your GitHub account.
+
+    a. Run the following command to export your GPG public key in ASCII-armored format:
+
+    ```bash
+      gpg --armor --export <GPG_KEY_ID>
+      Replace <GPG_KEY_ID> with the actual key ID.
+    ```
+
+    b. Copy the entire output, including the lines that start with "-----BEGIN PGP PUBLIC KEY BLOCK-----" and "-----END PGP PUBLIC KEY BLOCK-----".
+
+    c. Go to your GitHub Settings.
+
+    d. Click on "SSH and GPG keys" in the left sidebar.
+
+    e. Click the "New GPG key" button.
+
+    f. Paste your GPG public key into the provided text box.
+
+    g. Click the "Add GPG key" button.
+
+    h. Now your GPG public key is associated with your GitHub account, and you can sign your commits for added security.
+
+3.  Configure Git to use your GPG key:
+
+    ```bash
+    git config --global user.signingkey <GPG_KEY_ID>
+    ```
+
+4.  Set Git to sign all your commits by default:
+
+    ```bash
+    git config --global commit.gpgSign true
+    ```
+
+5.  Commit your changes with the -S option to sign the commit:
+    ```bash
+    git commit -S -m "your commit message"
+    ```
+
+For further assistance, please refer to the [GitHub documentation on signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
+
 ---
 
 ## License