summaryrefslogtreecommitdiff
path: root/doc/branches.md
diff options
context:
space:
mode:
authorJF <jf@codingfield.com>2022-01-07 16:31:01 (GMT)
committerGitea <gitea@fake.local>2022-01-07 16:31:01 (GMT)
commitadc7909c9823c5cd9fc9888a84e84f9182b9088f (patch)
tree778abfb7792fb7e58e3ec4408c9e56444f383e25 /doc/branches.md
parentcfef0131b7b1bb83c81db417c43d6d499594125f (diff)
parent26ae828e393d28390c5ea718bec9d4c1a96435ac (diff)
Merge branch 'develop' of JF/PineTime into master
Diffstat (limited to 'doc/branches.md')
-rw-r--r--doc/branches.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/branches.md b/doc/branches.md
index ef280f4..3c86375 100644
--- a/doc/branches.md
+++ b/doc/branches.md
@@ -1,7 +1,7 @@
# Branches
The branching model of this project is based on the workflow named [Git flow](https://nvie.com/posts/a-successful-git-branching-model/).
-It is based on 2 main branches:
+The project is based on 2 main branches:
- **master** : this branch is always ready to be deployed. It means that at any time, we should be able to build the branch and release a new version of the application.
- **develop** : this branch contains the latest development that will be integrated in the next release once it's considered as stable.
@@ -9,4 +9,4 @@ New features should be implemented in **feature branches** created from **develo
To release a new version of the application, when develop is considered stable, a **release** branch is created from **develop**. This can be considered as a *release candidate* branch. When everything is OK, this release branch is merged into **master** and the release is generated (a tag is applied to git, the release note is finalized, binaries are built,...) from **master**.
-Git flow also supports the creation of **hotfix** branches when a bug is discovered in a released version. The **hotfix** branch is created from **master** and will be used only to implement a fix to this bug. Multiple hotfix branches can be created for the same release if more than one bugs are discovered. \ No newline at end of file
+Git flow also supports the creation of **hotfix** branches when a bug is discovered in a released version. The **hotfix** branch is created from **master** and will be used only to implement a fix to this bug. Multiple hotfix branches can be created for the same release if multiple bugs are discovered. \ No newline at end of file