From 73006997809a6427998865b5e781b6255926e1e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Cruz?= <jose.cruz@incognia.com>
Date: Fri, 27 May 2022 16:15:26 -0300
Subject: [PATCH 1/2] chore(README.md): adds deployment section

---
 README.md | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 89a5bec..eb3f31d 100644
--- a/README.md
+++ b/README.md
@@ -198,8 +198,39 @@ Every method call can throw `IncogniaHTTPError` and `IncogniaError`.
 
 ## How to Contribute
 
-If you have found a bug or if you have a feature request, please report them at this repository
-issues section.
+Your contributions are highly appreciated. If you have found a bug or if you have a feature request,
+please report them at this repository
+[issues section](https://github.com/inloco/incognia-python/issues).
+
+### Development
+
+#### Deployment
+
+On GitHub, you should merge your changes to the `main` branch, create the git
+[versioning](#Versioning) tag and finally push those changes:
+
+```shell
+$ git checkout main
+$ git pull
+$ git merge <your_branch>
+$ git tag -a v<version> -m <description> # the versioning tag requires the prefix v
+$ git push origin HEAD --tags
+```
+
+Our CI will build images with the tagged version and publish them
+to [our PyPI repository](https://pypi.org/project/incognia-python/).
+
+#### Versioning
+
+We deploy 3 digit version strings in a form of `{Major}.{Minor}.{Patch}` scheme.
+
+- _Major version update_ - Major functionality changes. Might not have direct backward
+  compatibility.
+  For example, multiple public API parameter changes.
+- _Minor version update_ - Additional features. Major bug fixes. Might have some minor backward
+  compatibility issues. For example, an extra parameter on a callback function.
+- _Patch version update_ - Minor features. Bug fixes. Full backward compatibility. For example, an
+  extra fields added to the public structures with version bump.
 
 ## What is Incognia?
 

From 4412b8b1d5c4596f41213642a4c9a939d99078df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Cruz?= <jose.cruz@incognia.com>
Date: Tue, 31 May 2022 19:13:10 -0300
Subject: [PATCH 2/2] chore(README.md): changes versioning section order, adds
 release example

---
 README.md | 39 +++++++++++++++++++++++++--------------
 1 file changed, 25 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index eb3f31d..d9150c5 100644
--- a/README.md
+++ b/README.md
@@ -204,7 +204,20 @@ please report them at this repository
 
 ### Development
 
-#### Deployment
+#### Versioning
+
+This project uses [Semantic Versioning](https://semver.org/), where version follows
+`v{MAJOR}.{MINOR}.{PATCH}` format. In summary:
+
+- _Major version update_ - Major functionality changes. Might not have direct backward
+  compatibility.
+  For example, multiple public API parameter changes.
+- _Minor version update_ - Additional features. Major bug fixes. Might have some minor backward
+  compatibility issues. For example, an extra parameter on a callback function.
+- _Patch version update_ - Minor features. Bug fixes. Full backward compatibility. For example,
+  extra fields added to the public structures with version bump.
+
+#### Release
 
 On GitHub, you should merge your changes to the `main` branch, create the git
 [versioning](#Versioning) tag and finally push those changes:
@@ -213,24 +226,22 @@ On GitHub, you should merge your changes to the `main` branch, create the git
 $ git checkout main
 $ git pull
 $ git merge <your_branch>
-$ git tag -a v<version> -m <description> # the versioning tag requires the prefix v
+$ git tag -a v<version> -m "<description>"
 $ git push origin HEAD --tags
 ```
 
-Our CI will build images with the tagged version and publish them
-to [our PyPI repository](https://pypi.org/project/incognia-python/).
-
-#### Versioning
+- example:
 
-We deploy 3 digit version strings in a form of `{Major}.{Minor}.{Patch}` scheme.
+```shell
+$ git checkout main
+$ git pull
+$ git merge feat/some-feature
+$ git tag -a v2.1.0 -m "This release adds some feature..."
+$ git push origin HEAD --tags
+```
 
-- _Major version update_ - Major functionality changes. Might not have direct backward
-  compatibility.
-  For example, multiple public API parameter changes.
-- _Minor version update_ - Additional features. Major bug fixes. Might have some minor backward
-  compatibility issues. For example, an extra parameter on a callback function.
-- _Patch version update_ - Minor features. Bug fixes. Full backward compatibility. For example, an
-  extra fields added to the public structures with version bump.
+Our CI will build images with the tagged version and publish them
+to [our PyPI repository](https://pypi.org/project/incognia-python/).
 
 ## What is Incognia?