Branch Naming Convention

Branch Naming Convention

Why?

• Branch naming convention will allow us to travel through all branches with a safe and secure approach.

How?

For any division(web, backend, android) it is planned to name as follows:

• If division wants to implement a "feature", then the proper command should be:

  • git checkout -b <div_name>-feature/<feature_name>
  • e.g. If backend wants to implement a feature named "login-function", it should be
    • git checkout -b backend-feature/login-function
  • e.g. If web wants to implement a feature named "login-function", it should be
    • git checkout -b web-feature/login-function
  • e.g. If android wants to implement a feature named "login-function", it should be
    • git checkout -b android-feature/login-function

• If division wants to fix a "bug" , then the proper command should be:

  • git checkout -b <div_name>-bugfix/<bug_name>
  • e.g. If backend wants to fix a "bug" named "login-function", it should be
    • git checkout -b backend-bugfix/login-function
  • e.g. If web wants to fix a "bug" named "login-function", it should be
    • git checkout -b web-bugfix/login-function
  • e.g. If android wants to fix a "bug" named "login-function", it should be
    • git checkout -b android-bugfix/login-function

• <div_name> := web, backend, android

• <bug_name> := A totally descriptive set of words to explain the bug, use 1-3 word(s)

• <feature_name> := A totally descriptive set of words to explain the feature, use 1-3 word(s)

This approach is fail-safe to checkout an undesired branch by mistake