您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

iOS 程式碼審查流程(Code Review for iOS)

編輯:iOS 開發綜合

iOS App 開發團隊使用 Gerrit 進行程式碼審查。以下說明假設你使用的是較新版本的 Mac OS X。

目錄

本文依序涵蓋:初次使用 Git、啟用審查帳號、把程式碼取回本機、提出修改並申請審查、更新你的程式碼、Gerrit 因合併衝突而無法送出時的處理、程式跑不起來時的排查,以及一組 Git 實用技巧。

初次使用 Git?

如果你是 Git 新手,建議先讀官方 Git 書的前三章,這會讓後續省下不少力氣。就算現在不讀,至少等到被 Git 折磨得夠嗆時再回頭看。另外可參考 Gerrit Code Review 工具的簡介,並遵循團隊制定的 Common Workflow,以避免常見的坑。

啟用程式碼審查帳號

  1. 用你的 LDS Account 登入程式碼審查網站。
  2. 向管理員申請對應專案的權限。

把程式碼取回本機

  1. 若還沒做過,先設定密碼快取。
  2. Clone 你要處理的專案(以下指令中的 "PROJECT" 請替換為實際專案名稱;這一步使用 LDS Account 密碼,有快取後只需輸入一次):
    git clone https://tech.lds.org/mobile/codereview/p/PROJECT
  3. Clone 專案用到的函式庫(並非每個專案都有,但做了也不吃虧),同樣使用 LDS 帳號憑證:
    cd PROJECT
    git submodule update --init --recursive
  4. 設定 commit hook。這個 hook 會自動為每個 commit 加上合適的 change ID,審查工具靠它把多個 commit 歸為同一個變更,方便來回打磨。跳過這步會導致無法 push,而且原因不明顯:
    curl https://tech.lds.org/mobile/codereview/tools/hooks/commit-msg > .git/hooks/commit-msg
    chmod u+x .git/hooks/commit-msg
  5. 設定 git push 去申請審查,跳過這步同樣會推不上去:
    git config remote.origin.push HEAD:refs/for/master
  6. 設定你的名字與 email,email 必須和 LDS Tech 註冊的一致,否則無法推送任何 commit:
    git config --global user.name "Your Name"
    git config --global user.email "your@email.address"
    若已經用錯誤的資訊提交過,可以:
    git commit --amend --author="Author Name <email@address.com>"
    若有多個 commit 資訊都錯了,就得走更深入的處理步驟。

提出修改並申請審查

  1. 確認自己在 master 分支:
    git checkout master
  2. 確認工作內容是最新版:
    git pull origin master
  3. 為你的修改建立新分支:
    git checkout -b <branchname>
  4. 動手修改。
  5. 檢視修改內容:
    git diff
    git status
  6. 在本機提交:
    git commit -a
    系統會要求輸入 commit message,建議格式如下:
    (PROJECT-245) Short summary of change (~50 chars max, issue ID in parentheses if applicable)
    
    A more elaborate summary of the committed changes and suggested tests.
    May have bullet points or paragraphs. Break at 72 chars.
    This is shown when users view the full commit.
  7. 提出審查:
    git push
    會詢問使用者名稱(LDS Account)與密碼,建議設定 git 憑證快取以免每次都要輸入。

更新你的程式碼

審查流程的目的在維持程式碼品質、確保每一行都有超過一組眼睛看過,並讓貢獻者與審查者彼此學習。幾乎每個審查都會要求做一些調整,即使只是小改。遇到這種情況:

  1. 把已送出的審查版本 checkout 下來。到 Gerrit 中找到你送出的變更,捲到最新的 patch set,在「Download」區塊確認上方選的是「Checkout」與「HTTP」,複製那行 git fetch https... 到終端機執行。
  2. 進行修改。注意:不要 rebase 你的變更,否則在 Gerrit 中就只看得到整批差異了。
  3. 檢視修改:
    git diff
    git status
  4. 提交並再次申請審查。不要用 -m 參數,因為那會覆寫掉 change ID;直接在編輯器中更新 commit 描述:
    git commit -a --amend
    git push

Gerrit 因合併衝突而無法送出時

送出變更時若出現「Your change could not be merged due to a path conflict」,請依下列步驟解決:

  1. 確認 master 分支是最新的:git pull origin master
  2. Checkout 有衝突的變更集,可直接從審查工具的「Download」區塊複製指令,形狀類似:git fetch https://hiltonc@tech.lds.org/mobile/codereview/PROJECT refs/changes/08/8/2 && git checkout FETCH_HEAD
  3. 相對於 master 做 rebase(這時應該會出現衝突警告,正常):git rebase master
  4. 若還沒設定 mergetool,先設定好(見下方技巧)。
  5. 執行 git mergetool 逐一解決衝突,存盤並關閉每個檔案。
  6. 衝突解決後讓 rebase 繼續:git rebase --continue
  7. 推送解決後的衝突以進行審查:git push
  8. 回到審查工具重新檢視變更集,再送出合併到 master。

程式跑不起來時

許多建置與執行問題可以靠下列其中一項或全部解決:

  1. 在 git repo 中執行 git submodule update --init --recursive
  2. 在 iOS Simulator 點「iOS Simulator」→「Reset Content and Settings...」
  3. 在 Xcode 中按 command-option-shift-k(或按住 option 並選擇「Product」→「Clean」)

Git 實用技巧

把多個 commit 合併成一個

  1. 提供你想編輯的最後一個 commit 的父節點(例如 3):
    git rebase -i HEAD~3
    (是 dash i 加 tilde 3)
  2. 編輯器中會列出 commits,把想合併的項目從 'pick' 改成 's':
    pick f7f3f6d changed my name a bit
    s 310154e updated README formatting and added blame
    s a5f4a0d added cat-file
  3. 存檔並離開編輯器:
    :wq
  4. 接著會顯示所有 commit message,把它們合併成一個,並確保只留一個 change-id。
  5. 完成後 commits 就被合併了。若上面的簡短說明不夠用,可進一步了解 interactive rebase(特別是 squash commits 那一節)。

丟掉未提交的修改

警告:這會失去所有未提交或未 stash 的修改。

要徹底丟掉,執行 git reset --hard HEAD;若只想暫時收起來,用 git stash。

把 repo 重設成與公開 repo 一致

警告:這些步驟會清掉你在該分支上所有未發布的修改,即使已經 commit 到該分支也一樣(若已 commit 到別的分支或有 stash 則不受影響,但仍請小心)。

  1. 用 git reset --hard HEAD~<number> 丟掉不想要的 commits,number 換成略多於要丟棄數量的值。例如 git log 顯示有 3 個要丟掉,用 git reset --hard HEAD~5 即可(注意 tilde)。
  2. 用 git pull origin master 更新到公開 repo 的狀態。若無效,就得动用 Stack Overflow 上那些更暴力的手段了。

設定 difftool 與 mergetool

git config --global diff.tool opendiff

git config --global merge.tool opendiff

mergetool 預設會保留 ".orig" 備份檔,若想關閉可執行 git config --global mergetool.keepBackup false。

本頁最後修改於 2013 年 12 月 4 日 15:15,累計瀏覽 6,903 次。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved