From 5d45d7ee64919f7b42419ece3d1ce5dce099d117 Mon Sep 17 00:00:00 2001
From: Omer Mujtaba <omer.mujtaba96@gmail.com>
Date: Wed, 28 Aug 2024 20:45:20 +0300
Subject: [PATCH] docs: Update README.md

---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8c86d94..56d0d73 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,36 @@ $ npm run test:e2e
 $ npm run test:cov
 ```
 
-## Documentation
+## API Swagger Documentation
 
 API documentation is available at http://localhost:3000/api-docs
+
+## Commit Message Guide
+
+### Commit Message Format
+
+```
+<type>(<scope?>): <subject>
+```
+
+#### Type
+
+Must be one of the following:
+
+- build: Changes that affect the build system or external dependencies (example scopes: node, npm)
+- chore: Updating tasks etc; no production code change
+- gh-actions: Changes to .github files and scripts (example scopes: ci, dependabot etc.)
+- docs: Documentation only changes
+- feat: A new feature
+- fix: A bug fix
+- perf: A code change that improves performance
+- refactor: A code change that neither fixes a bug nor adds a feature
+- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- test: Adding missing tests or correcting existing tests
+
+#### Scope
+
+- common: for changes made on src/common directory
+- config: for changes made on src/config directory
+- resources: for changes made on src/resources directory
+- lib: for changes made on root/libs directory