Skip to content

Instantly share code, notes, and snippets.

@fntsrlike

fntsrlike/git-team-work-flow.md

Last active October 14, 2022 06:23
Show Gist options
  • Save fntsrlike/323c171f88246c9357bb to your computer and use it in GitHub Desktop.
Save fntsrlike/323c171f88246c9357bb to your computer and use it in GitHub Desktop.
Download ZIP
Git 團隊工作流程風格：每當要做新專案時，都會貼這個給合作夥伴。
Raw
git-team-work-flow.md

Team Work Flow

Git

Setting

請依照您的作業系統針對版本控制換行字元同步做設定。

Windows

git config --global core.autocrlf true
git config --global core.safecrlf true

Unix-like

git config --global core.autocrlf input
git config --global core.safecrlf true

Github Flow and Branches

使用 Github Flow，每個人 Fork 一份回去，然後做完更改後提 Pull Request，然後經過至少一人 Code Review 後，Merge 到目標分支中。

分支慣例

  • master 是最穩定的版本。
  • develop 開發用分支，會在穩定後，用 merge request 併入 master
  • feature/**** 開發新功能用的分支，會在開發完成時，用 merge request 併入 develop
  • fixes/**** 修正 bug 用的分支，會在修正完成時，用 merge request 併入 develop

命名風格

使用 - 作為單字間的分隔，例如：

  • fixes/project-list-save-error-message
  • feature/auto-login

Commits

  • 用 git commit 取代 git commit -m "commit messages"。
  • Commit message 第一行不得超過 50 個字元。之後的行數不得超過 72 個字元。
  • Commit message 第一行應以大寫字母為開始，且建議為動詞。例如
    • Add
    • Change
    • Fix
    • Remove
    • Refactor
  • Commit message 第一行句尾，應不含 .
  • Commit 前，向自己發問 3 個問題：
    1. 為什麼這個改變是需要的？
    2. 他是如何解決這個問題的？
    3. 這個改變有副作用嗎？
  • 將 issue/story/card 的連結附在 commit message 中

Sample

Redirect user to the requested page after login

https://trello.com/path/to/relevant/card

Users were being redirected to the home page after login, which is less
useful than redirecting to the page they had originally requested before
being redirected to the login form.

* Store requested path in a session variable
* Redirect to the stored location after successfully logging in the user

Reference

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