Dev Conventions
  • Dev Conventions
  • Git
    • Branch Flow
    • Conventional Commits
    • Pull requests template
    • Before making the PRs in typescript, keep in mind
  • Typescript
    • Introduction
    • Good practices
    • Solid
    • Using pnpm for Package Management
    • NestJs
    • NextJs
    • React
    • NestJs Testing
    • React Testing
    • Npm Registry
  • PYTHON
    • Introduction
    • Good practices
    • Testing
    • Naming Convention
  • DevOps
    • Introduction
    • Github Actions
    • Creating a Github Actions Workflow
  • Agile
    • Story Points
Powered by GitBook
On this page
  • Development Flow
  • Steps:
  1. Git

Branch Flow

PreviousDev ConventionsNextConventional Commits

Last updated 9 months ago

Note: Developers derive and make PRs to the dev branch and lower.

Development Flow

  • Upstream repositories:

    • Protected branches are:

      • Main: production branch

      • Release: Pre-production branch

      • Dev: Development branch

      • Hot Fix: Branch to apply hot fixes

      • QA: QA environment branch

    • Other branches:

      • IS-(#feature)

Steps:

  1. Go to the assigned JIRA story and create a branch through the ticket (this creates a branch with the story identifier in the upstream repository, which will be used for merging after the story development, e.g., GAN-188).

  2. Create a new foo branch from the dev branch of your fork to develop the story.

  3. Develop the story in the foo branch.

  4. When you have finished developing the story:

    a. SQUASH INTO A SINGLE COMMIT in the dev branch of your fork (to keep the commit history of the upstream repository clean).

    b. Make a commit with a message that starts with the story identifier (e.g., git commit -m "GAN-188: ...").

  5. Make a PR to merge the dev branch of your fork into the upstream story branch created from JIRA in step 1 (e.g., GAN-188).

  6. Once the PR is accepted and merged:

    a. Delete the foo branch on upstream.

    b. Sync your fork with the upstream repository.

  7. Repeat the process.