Skip to content

Naming branches

Mostafa Khattat edited this page Sep 18, 2017 · 1 revision

General

Please use underscores to separate words and forward slashes for sections.

Structures

Sections

Branch section name Used for Branch name example
general Mainly overall general/wip/feature_name
gui Mainly in the gui package gui/feat/feature_name
data Mainly in the data package data/wip/feature_name
logic Anything to do with the Game logic logic/wip/feature_name
experimental Branch with experimental code outside of project experimental/junk/experiment_name

Branch type tags

Branch tag name Used for Branch name example
wip Works in progress; stuff I know won't be finished soon general/wip/feature_name
feat Feature I'm adding or expanding general/feat/feature_name
bug Bug fix general/bug/feature_name
junk Throwaway branch created to experiment general/junk/feature_name

Feature name examples

Section name Used for Branch name example
a_feature Adding a feature gui/feat/a_feature
fancy_update Adding a fancy update to a feature gui/feat/a_feature/fancy_update
refactoring Bug fix gui/feat/a_feature/refactor

Clone this wiki locally