Git practice

[reboottime]

Git workflow on team collaboration

• View using Git at a macro level
  

• The step by step guide

---

[reboottime]

Git Conventional Commit Message

• Why:

  • Improve readability: To help people to understand what's going on for a commit quickly when working in a team collaboration settings or for a long-term maintaining project.
  • A good commit message also helps when using tool to generate automatically changelog

• How: pattern

• Tools: Conventional commits plugin on VSCode
  • how to install it
  - how to use it

[reboottime]

Git Branch Naming Conventions

Like conventional commit messages, having a good git branch naming convention when cooperating with a team or maintaining a long-term project helps understand a branch's indentation.

A good practice is using the following pattern.

<token>/<part><short_description>

The commonly used token in practice is

• refactor
• feature
• fix

The part can be a ticket id if your team is working on a ticket system or just an accurate and short description of the branch's work.

For example,

• for a bug fixing ticket, we can name the ticket git branch as fix/prd-123.
• for a feature you are building, we can name the git branch as feature/add-sidebar.

---

For more background, please read what are some examples of commonly used practices for naming git branches

[reboottime]

Frequently asked questions

• what is the difference between git fetch and git pull

  • git fetch asks git if the remote has any updates that the local work directory doesn't have. git fetch command doesn't involve in file transferring from remote to local git work repository

  • git pull pull remote changes if there are any. git pull command involve in file transferring from remote repo to local git repository

  • If you want to use git fetch and get the remote changes, the combined git commands is

     git fetch; // ask git to check remote repository metadata
     git merge; // ask git merge remote changes to local repository

[reboottime]

Frequently asked usage on git commands

• how to delete all branches except main

  • keep main branch only

  git branch -D `git branch | awk '{ if ($0 !~ /main/) printf "%s", $0 }'`

  • keep multiple branches

  git branch -D `git branch | awk '{ if ($0 !~ /<Branch_You_Want_to_Keep1>|<Branch_You_Want_to_Keep2>/) printf "%s", $0 }'`

• how to squash last n commits

  • write commit message from scratch

  git reset --soft HEAD~3 &&
  git commit

  • editing existing messages

  git reset --soft HEAD~3 && 
  git commit --edit -m"$(git log --format=%B --reverse HEAD..HEAD@{1})"

• how to cherry pick and how to cherry pick multiple commits

[reboottime]

Reference Materials

1. Understand git workflow in a single picture by bytebytego
2. Write git commit messages like a PRO with Conventional Commits
3. Easy conventional commits in VSCode
4. How to squash last n commits
5. git cherry pick tutorial
6. git fetch vs git pull | Live Demo | Ashok IT
7. what are some examples of commonly used practices for naming git branches
8. how to delete all branches except main
9. Chingu git usage presentation: using git in a team
10. how to cherry pick
11. how to cherry pick multiple commits