Git Process Cheat Sheet

Full documentation here: https://www.notion.so/On-boarding-d06a0276960f4046884f2293f02b49e2

Feature Checklist

• Have I committed all my code?
• Have I written good commit messages?
• Have I pushed my code?
• Have I made a PR with a good description?
• Have I moved my ticket to "ready for review" in the kanban board?
• Have I posted in the "request-for-review" channel?

Changes Needed Checklist

• Have I acknowledged the changes that need to be made?
• Have I asked necessary clarifying questions?
• Have I satisfied all of the changes, but no more?
• Have I committed my code?
• Have I pushed my code?
• Have I moved my ticket to "ready for review" in the kanban board?
• Have I posted in the "request-for-review" channel?

General Tips

• Be sure to have good commit messages EVERY TIME you commit, refrain from using a commit message as save
• change your commit message editor and write out multi-line commits:
  • https://zwbetz.com/use-vscode-as-your-default-text-editor-for-git/
• Follow this commit guide: https://gist.github.com/matthewhudson/1475276
• Use an active voice: Fix card generator
• IMPORTANT: https://chris.beams.io/posts/git-commit/

I need to....

I need to create a feature

• Use the feature/ prefix for your branch name
• feature/22-card-flipping-animation

I need to fix a bug that exists in main

• Use the bug/ prefix for your branch name
• bug/44-fix-weird-issue

I need to refactor some code

• Use the refactor/ prefix for your branch name
• refactor/123-update-css-vars

I need to merge upstream into my local branch to continue working

This can happen when you are dependent on some changes that were merged after you created your branch

• Use git stash if you are not ready to commit a meaningful commit
• Create a backup branch in case things go south and you need to restart.
• Checkout to main and pull: git checkout main; git pull
• checkout back to your feature branch and merge main: git merge main --ff-only
  • We use the --ff-only flag to prevent a merge commit
• If the --ff-only flag fails and asks you to do a rebase: git rebase main
• If this doesn't go smoothly and you do not know how to progress, ask for help

I need to return the code I stashed back to my working enviornment

• use git stash pop or git stash apply

I need to make some changes to my commit messages

THIS IS VERY DANGEROUS IF DONE INCORRECTLY

• Make a backup branch before making ANY history changes: git checkout -b feature/33-my-backup-branch-with-good-name
• https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History