Skip to content

Instantly share code, notes, and snippets.

@felipekm

felipekm/git-commit-best-practices.md

Last active June 3, 2022 19:18
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save felipekm/a567f3a4aeed4ee842296748e44bbe8a to your computer and use it in GitHub Desktop.
Save felipekm/a567f3a4aeed4ee842296748e44bbe8a to your computer and use it in GitHub Desktop.
Download ZIP
Git Commit Best Practices
Raw
git-commit-best-practices.md

Git

Git Best Practices

  1. Test all changes before pushing a PR to the remote branch

  2. Squash commits in pr's

  3. Individual contributor's PR's can be Squashed and Merged on github

  4. Name commits intelligently inside yout reposity. They should follow this format (): . I.e., bug(ModuleName): Fixing merchant logos for....

    4.1. Change Types:

    • feat - for adding a new feature
    • fix - bug fix
    • docs - documentation
    • style - style changes only
    • refactor - code refactoring
    • revert - reverting a previous commit
    • tech - tech debt

  5. Add appropriate screenshots to all pr's

  6. Do not merge our own pr's

  7. Reach out to any reviewers who have commented on a pr before merging a pr

  8. Ensure at least 2 reviewers review a pr before merging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment