Skip to content

Mivazone/git_style_guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

A Git Style Guide

Table of contents

  1. Branches
  2. Commits
  3. References

Branches

Alt text

  • Master branch: This branch just for stable version.
  • Hotfix branch: For quick bug fixes from stable version.
  • Release branch: For beta version.
  • Develop: It is for app development and we mostly work with this branch.
  • Feature: There can be many branches for feature.

Commit message style

Semantic Commit Messages

Format: <type>(<scope>): <subject> <scope> is optional

Example feat: add hat wobble

^--^ ^------------^

| |

| +-> Summary in present tense.

|

+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)
  • build: Related to build process changes;
  • ci: Related to continuous integration setup changes;
  • chore: About build process or auxiliary tool changes;
  • docs: Limited to documentation changes;
  • feat: Introducing new features;
  • fix: Addressing bug fixes;
  • perf: Enhancing code performance;
  • refactor: Code changes without bug fixes or new features;
  • revert: Reverting previous changes;
  • style: Markup, formatting, or whitespace changes;
  • test: Adding missing tests.

Example <scope> value:

  • init
  • runner
  • watcher
  • config
  • web-server
  • proxy
  • etc.

References:

About

A Git Style Guide

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published