Merge pull request #35 from aj3sh/conventional-commit-doc

docs: add Conventional commit message info in README

Author: subashcs

Diff for: README.md

@@ -8,6 +8,33 @@
 
 commitlint is a tool designed to lint your commit messages according to the [Conventional Commits](https://www.conventionalcommits.org/) standard for your pre-commit hook and GitHub Actions.
 
+## Conventional Commits
+
+A conventional commit message follows a specific format that includes a prefix indicating the type of change, an optional scope for context, and a concise description of the modification.
+This structure improves readability, facilitates automated changelog generation, and ensures a consistent commit history.
+
+The commit message should follow this structure:
+
+```
+<type>(<optional scope>): <description>
+
+[Optional body]
+```
+
+**Type:** Indicates the type of change, such as build, ci, docs, feat, fix, perf, refactor, style, test, chore, revert, or bump.
+E.g., `feat: add JSON parser`.
+
+**Scope:** Additional contextual information.
+E.g., `feat(parser): add JSON parser`.
+
+**Description:** Brief description of the commit.
+
+**Body:** A detailed description of the commit.
+
+For more details, please refer to the Conventional Commits specification at https://www.conventionalcommits.org/en/v1.0.0/
+
+> NOTE: commitlint also checks the length of the commit header (**max 72 characters**). The commit header refers to the first line of the commit message (excluding the body).
+
 ## How to use
 
 ### For pre-commit
@@ -83,16 +110,16 @@ jobs:
 | 1   | **exit_code** | Integer | The exit code of the commitlint step.                                        |
 | 2   | **status**    | String  | The outcome of the commitlint step. Possible values: 'success' or 'failure'. |
 
-
 ## CLI (Command Line Interface)
 
-### Installation 
+### Installation
 
 ```shell
 pip install commitlint
 ```
 
 ### Usage
+
 ```
 $ commitlint --help
 usage: commitlint [-h] [-V] [--file FILE] [--hash HASH] [--from-hash FROM_HASH] [--to-hash TO_HASH] [--skip-detail] [commit_message]
@@ -114,8 +141,9 @@ optional arguments:
 ```
 
 ### Examples
+
 Check commit message directly:
- 
+
 ```shell
 $ commitlint "chore: my commit message"
 ```