docs: add contributing branch and tag naming conventions

xamfy · Oct 12, 2022 · 304b7a9 · 304b7a9
1 parent 827891c
commit 304b7a9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/contributing/branch-naming-convention.md b/docs/contributing/branch-naming-convention.md
@@ -0,0 +1,9 @@
+#### Branch naming convention
+
+Following are the branch naming convention for the repository.
+
+  * `main` - The main branch where the source code of HEAD always reflects a production-ready state.
+  * `develop` - The main branch where the source code of HEAD always reflects a state with the latest delivered development changes for the next release.
+  * `feature/*` - Branch from `develop` and merge back into `develop`. Branch naming convention is `feature/<issue-number>-<issue-title>`. For example, `feature/1234-add-branch-naming-convention`.
+  * `release/*` - Branch from `develop` and merge back into `develop` and `main`. Branch naming convention is `release/<version-number>`. For example, `release/1.0.0`.
+  * `hotfix/*` - Branch from `main` and merge back into `develop` and `main`. Branch naming convention is `hotfix/<issue-number>-<issue-title>`. For example, `hotfix/1234-fix-branch-naming-convention`.
diff --git a/docs/contributing/tag-naming-convention.md b/docs/contributing/tag-naming-convention.md
@@ -0,0 +1,5 @@
+#### Tag naming convention
+
+Following are the tag naming convention for the repository.
+
+* `v*.*.*` - Tag naming convention is `v<version-number>`. For example, `v1.0.0`.