docs: added the commit related info in read me

XeroAPI · Oct 3, 2024 · 4c31a16 · 4c31a16
1 parent 3a7b94d
commit 4c31a16
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,15 @@ In Release (used for one or more SDKs)
 ## Code Generators
 We are using [OpenAPI generator](https://github.com/OpenAPITools/openapi-generator) along with these OAS yaml files to generate our new SDKs.
 
+## Contribution guide
+* Please run ` npm install ` in root directory before working in this repo.
+* It will enable commit linting in your local
+* run ``` git commit ``` before making any commit
+* You will be prompted with a interactive commit cli before each commit to keep the commit messages structured to maintain repo's release management process.
+![alt text](images/cz-cli.png)
+* You will only be able to commit through your integrated or local terminal and no other GUI.
+* We are using [commitizen cz-cli](https://github.com/commitizen/cz-cli) for our commit ruling set up.
+
 ## Preview
 There are lots of tools available for viewing and editing OpenAPI descriptions in a nicely formatted way. A popular tool is SwaggerHub - a version of which is [hosted here](https://app.swaggerhub.com/home). 
 

diff --git a/images/cz-cli.png b/images/cz-cli.png