From 694fbba484749923b140ad509a3656ef574f4bbc Mon Sep 17 00:00:00 2001 From: Omer Mujtaba Date: Wed, 28 Aug 2024 21:04:14 +0300 Subject: [PATCH] docs: Update README.md --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 618c2bd..4a8f69b 100644 --- a/README.md +++ b/README.md @@ -57,20 +57,20 @@ API documentation is available at http://localhost:3000/api-docs 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 +- **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 +- **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