Git naming conventions

readme.md

Git Naming Convention

• Branch naming convention

  • master (production code)
  • sandbox (staging code)
  • develop (development code)
  • feature/XXX
  • release/XXX
  • hotfix/XXX

• Commit naming convention type

  • fix: (bug fix for the user, not a fix to a build script)
  • feat: (new feature for the user, not a new feature for build script)
  • chore: (updating grunt tasks etc; no production code change)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • perf: (a code changes that improves performance)
  • test: (adding missing tests, refactoring tests; no production code change)
  • ci: (changes to our CI configuration files and scripts)
  • build: (changes that affect the build system or external dependencies)
  • security: (for security issue fix commit)
  • release: (for publishing commit)
  • deps: (for dependencies upgrading or downgrading commit)
  • example: (for example code commit)

• If commit is breaking changes append ! at front, example !fix: correct spelling of referrer in header