Skip to content
This repository was archived by the owner on Apr 27, 2024. It is now read-only.

Git flow

Khiem Ton That edited this page Feb 1, 2024 · 1 revision

Ticket Types

image

  • Task type
  • Bug type

Branch Naming

  • Naming follows the ticket name on Jira.
    • Example ticket names:
      • WW-46
      • WW-45

Commit Convention

Pattern: {feat || fix}[{ticket name}]: {message}

  • Example for ticket task:

    • feat[WW-01]: doing something
  • Example for ticket bug:

    • fix[WW-01]: doing something

Other Git Conventions:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Git Flow

image

Branch

  • Master: Main branch representing the stable, production-ready version.
  • Hotfix: Used for urgent bug fixes in the production environment.
  • Release: Prepares for a new release with final testing and adjustments.
  • Dev: Integration branch for ongoing development and feature testing.
  • Feature: Created for developing specific features or user stories.

Flow

  1. Receive task.
  2. Make sure the dev branch is always the latest compared to the remote repo.
  3. Checkout branch feature from dev.
  4. After completing, create pull request to dev branch.

Note:

  • Feature only branched from dev.
  • Only merge feature into dev.
  • Always make sure dev is newest before checking out a new feature branch.

Clone this wiki locally