/
Git Workflow

Git Workflow

Owned by Joanna He (Unlicensed)
Last updated: Feb 18, 2023 by Matthew Liu (Unlicensed)
1 min read

Branches

Conventions

  • Create the git branch off the assigned Jira ticket - this will automatically name the branch as JOB-NUMBER-task-name and sync changes to the Jira ticket (e.g. making a PR will move the card from in progress to review). However make sure to change the name of the branch to be in the format of name/JOB-XX-<feature-name>.

  • We are not enforcing any rules on commit messages but we hope see that it in general describes the task that you are doing.

  • Use conventional commit syntax when naming your PRs.

Workflow

  • Create git branch from Jira ticket

  • Work on the ticket (remember to pull from develop/main often, to avoid merge conflicts)

  • Open a PR, resolve any comments and once a lead approves, merge the PR into develop/main (depending on ticket requirements)

Reviewing

  • Anyone is welcome to review PRs!

  • Some things to look out for:

    • Code style (e.g. indentation, commenting, easy to understand variable names)

    • Typos

    • Over engineered/buggy code

Related content