Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.01 KB

GIT_DEV_GUIDELINE.md

File metadata and controls

46 lines (34 loc) · 2.01 KB

GIT development guideline

Commandments

Branch

  • Create a new branch for every task / small feature / bug fix from master
  • Branch prefix:
    • Feature: feature/
    • Release: release/
    • Hotfix: hotfix/
    • Support: support/
  • Branch name should refer to issue number: e.g feature/#9_referral_link

Commit

  • Make small/atomic commits.

  • Do not commit vendor/compiled code.

  • Do not commit commented-out code — just delete it.

  • Explain the why, not the what, in your commit message:

    # Bad
    Updated index.js field
    # Good
    Remove debug statement from index.js
    
  • Your commit message must also refer to issue number:

    #9 Remove debug statement from index.js
    
  • Rebase instead of merge to resolve conflicts. However, do not rebase or amend your branch/commit if your branch is already pulled down by someone else.

PR / CHANGELOG

  • Use pull requests. Get reviews.
  • Do not commit or push directly to the master branch (you won't have permission to do this anyway).
  • Before creating the PR, please make sure:
    • An entry is added to the CHANGELOG.md. Your changelog entry should also refer to the issue number.
    • Your branch is based on the latest change in the master branch. If not, rebase onto the latest changes of the master branch.
    • Your PR is free of merge conflict. If not, please rebase onto the latest changes of the master branch and resolve the conflicts.