search

chingu-voyages / v28-geckos-team-06

Add-project-description-here | Voyage-28 | https://chingu.io/ | Twitter: https://twitter.com/ChinguCollabs
1 stars 1 forks source link

Update git branch strategy model in readme #11

Open LogicUI opened 3 years ago

LogicUI commented 3 years ago

README should have the following Info 1) Main branches dev/prod 2) Which branch to branch out doing development and deployment 3) Naming conventions Must include Feature/, Bugfix/

refer to https://docs.chingu.io/techres/gitbranches/

LogicUI commented 3 years ago

Git Branching Model & Release Strategy

Master Branch

The source code of HEAD always reflects a production-ready-state.

Develop Branch

The source code of the HEAD always reflects a state with the latest delivered development changes for the next release.

Supporting branch

Types of Supporting Branch Description Branch off from Merge back into Naming Conversion Example
Feature Used to develop new features develop develop feature/ticket-summary feature-recipe-title
Bugfix Arise from the necessity act upon an undesired state of development develop, release branches develop, release branches bugfix/ticket-summary bugfix-title-does-not-display-clearly
hotfix Hotfix branch arises from the necessity to act immediately upon an undesired state of a live production version. master master develop hotfix/ticket-summary hotfix/login-error
Release Release branch supports the preparation of a new production release, reflects the desired state of the new release develop master, develop release/release-number release/1.0.0

Commit Messages

Commit messages should follow based on the branch name assigned. E.g Feature/recipe-title.

Any feedback or changes made after a PR is made should edit the existing commit name instead of creating a new commit.

this can be done using the following command 

after adding some changes to local git repo..
git commit --amend ( modifies the existing branch with new changes)

Merge Strategy

Squash, fast-forward the only is set to the default and only merge strategy. If the source code is out of date with the target branch. reject merge request. Otherwise, combine all commits into one new squash commit on the target branch.

Overview of the branch model

image.png