Skip to content

[docs] Add CONTRIBUTING.md file to detail expectations for contributors #4

@pnc-nz

Description

@pnc-nz

Git branch prefixes

Using prefixes in branch names is a popular strategy to categorize branches based on their purpose:

  • Feature branches: Prefixed with feature/, these branches are used to develop new features.
  • Bugfix branches: Prefixed with bugfix/, these branches are used to make fixes.
  • Release branches: Prefixed with release/, these branches prepare a codebase for new releases.
  • Hotfix branches: Prefixed with hotfix/, these branches address urgent issues in production.

Git Flow branch naming conventions

Git Flow is a branching model that outlines a strict branching strategy designed for managing releases. The main branches in Git Flow include:

  • Main branch: Serves as the primary branch where the codebase's current production state is reflected.
  • Develop branch: Aggregates developments and features before they are released to the main branch.
  • Feature branches: Typically follow the naming pattern feature/*, these branches are used to develop new features.
  • Release branches: Named like release/*, these branches help manage the release process.
  • Hotfix branches: Named hotfix/*, these branches are created to quickly patch production releases.

Source

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions