Skip to main content

Git Conventions

commit msg​

Each commit should have a task number prefix, like:

GFENG-1234: Commit message

It's also a good practice to use branch naming like {Ticket number}/{a-description-about-the-code-changes}

branch​

We use main branch as default, and code is committed to prod from this branch only, after successful verification has taken place.

prs​

when read with the code changes:

  1. create a new pr in https://github.com/GoodFit-io/
  2. (opt) attach a note/sql snippet how you tested so it can be re-run buy reviewer

  1. (opt) add summary note to prs
  2. create a new msg in #eng-prs slack with pr link name you see in changed file
    1. expect reaction to it 💚 💛 👀

  1. when a conversation is opened review them
    • use reaction where you just agree with the change
    • add a comment if needed or not clear or don't agree
    • maintainers should indicate whether a comment is blocking or a suggestion/question
    • authors should exercise judgement when resolving threads
    • we favour velocity over "process for process sake"
  2. (opt) after code changes are committed to the remote paste the commit as comment to the message thread

  1. when pr is approved check which one makes more sense to choose

Use squash or merge on your discretion