Skip to content

Instantly share code, notes, and snippets.

@carmenchapa

carmenchapa/TLB-git-flow.md

Last active October 5, 2021 09:57
Show Gist options
  • Save carmenchapa/773411570572c7559c2bdc0938d6e96e to your computer and use it in GitHub Desktop.
Save carmenchapa/773411570572c7559c2bdc0938d6e96e to your computer and use it in GitHub Desktop.
Download ZIP
TLB git flow
Raw
TLB-git-flow.md

Branches

  • Automated CI will not triggered/performed on Feature branches.
  • Automated CI tests will be triggered for all Pull Requests.
  • Developers are not allowed to push commits direct to any main branches: origin/master, origin/develop, or origin/release.

Main branches

  • origin/master is the main branch where the source code of HEAD always reflects the current production-release.
  • origin/develop is the main development branch where the source code of HEAD always reflects the latest integrated development changes; ready for the next QA release. Some would call this the “integration branch”.

This is where any automatic nightly builds are built from.

  • origin/release is the QA branch used to perform acceptance, end-2-end testing, and other checks required before production release.

Feature branches

Feature are the branches in which all sprint work is performed. Feature-work changes can only be merged into origin/develop with Pull Requests. Long-lived feature branches should follow rule rebasing Often

  • origin/feature/<xxx> contain work for specific features, e.g. user login, some data visualization. This branches has to merge to origin/develop.
  • origin/hotfix/<xxx> are meant to fix urgent things that have to be deployed as soon as posible. Hotfix branches can be merged to origin/master.
  • origin/core/<xxx> contain work related to the project architecture or devOps, e.g. `origin/core/addendtoendtests.

Commits convention

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

  • chore: add Oyster build script
  • docs: explain hat wobble
  • feat: add beta sequence
  • fix: remove broken confirmation message
  • refactor: share logic between 4d3d3d3 and flarhgunnstow
  • style: convert tabs to spaces
  • test: ensure Tayne retains clothing

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment