Branch Name Format

Jump to bottom

neoFelhz edited this page Feb 13, 2017 · 1 revision

A Branch should include this three parts, and use / as sseparator:

type
scope
subject

Type

A type is used to mark what the branch used for.There are some examples:

feat: New Feature
fix: Fix a bug
docs: About Documentiations
style: Format (And it won't affect the code running)
refactor: Refactor(No new feature will be added or no bugs will be fixed)
test: Test
chore: Update our tools

scope

It is used to explain which parts will this branch mainly affected.

subject(Unnecessary)

This tell which objects will be affected, or why we open this branch.

Here are some examples for branch names:

fix/jsload
fix/comment/disqusclick
feat/sidebar
revert/nprogress