Branch Name Rules - bounswe/bounswe2023group2 GitHub Wiki

• Branch names should include team name:

  FE

  BE

  MO

• Branch names should be categorized into prefixes as:

  Feature: For new features or enhancements.

  Bugfix: For fixing bugs or issues.

  Hotfix: For critical fixes that need to be deployed immediately.

  Documentation: For documentation-related changes.

  Refactor: For refactoring code without adding new features.

  Release: For preparation of a new release.

  Test: Testing related work.

Example:

FE/feature/login-page

BE/feature/login-endpoints

MO/feature/login

BE/bugfix/fix-null-pointer-error

BE/hotfix/urgent-security-patch

FE/documentation/update-readme

• Use "-" between words in all small letters after the category.
• Provide a concise and descriptive title for the branch. The title should explain the purpose or goal of the branch.
• Keep branch names reasonably short, ideally under 50 characters, to maintain clarity and prevent issues with some systems or tools.
• Delete your branch after it is merged.