GitHub專案協作使用指南
GitHub 是一個基於 Git 的原始碼管理平台，因其在專案協作中的廣泛應用而備受歡迎，從小型專案和大學作業到企業級軟體開發，無所不包。借助 GitHub，團隊可以在同一程式碼庫上協同工作，避免互相覆蓋，有效地追蹤變更，進行技術討論，並在合併程式碼前進行程式碼品質審查。本文將提供一份實用的指南，指導您如何從零開始使用 GitHub 進行專案協作，並逐步建立更有效率的工作流程。
1. 理解基本概念：Git 與 GitHub
在開始之前，區分 Git 和 GitHub 非常重要。 Git 是一個運行在本機上的版本控制系統，用於記錄檔案變更。而 GitHub 則是一個基於 Web 的服務，它在線上託管 Git 程式碼倉庫，並提供諸如拉取請求、問題追蹤、程式碼審查和 CI/CD 自動化等附加功能。在協作中，Git 負責版本管理，而 GitHub 則作為一個結構化的「共享工作空間」。
2. 建立儲存庫和專案結構
第一步是在GitHub上建立一個程式碼倉庫：
1. 點選新建儲存庫。
2. 指定儲存庫名稱、描述和可見性（公開/私有）。
3. 可選：根據需要勾選「新增 README」、「.gitignore」和「許可證」。
README 文件是專案的初始文件（包括用途、安裝說明和貢獻說明）。 `.gitignore` 檔案可以阻止提交某些檔案（例如 `node_modules`、建置檔案或本機設定）。如果專案是開源的，或者您希望規範使用權限，那麼許可證就非常重要。
3. 將儲存庫克隆到本機
倉庫創建完成後，每個團隊成員需要使用以下命令將項目複製到各自的電腦上：
“‘重擊
git clone https://github.com/username/nama-repo.git
“
此命令會建立專案的完整本機副本，包括提交歷史記錄。然後，導航到專案資料夾：
“‘重擊
cd repo-name
“
4. Git身份配置
為確保每次提交都記錄在正確的貢獻者姓名下，請設定 Git 身分：
“‘重擊
git config --global user.name “你的名字”
git config –全域使用者.電子郵件“[email protected]“
“
這對於貢獻的透明度、變更審計和團隊溝通至關重要。
5. 協作的分支工作流程
有效的協作幾乎總是離不開分支的使用。分支允許每個人獨立開發新功能或修復漏洞，而不會影響主分支（通常是 `main` 或 `master`）。常見做法：
– `main`：穩定/可發佈程式碼
– `develop`（可選）：在穩定版發布前合併功能
– `feature/feature-name`：新功能開發
– `fix/bug-name`：錯誤修復
– `hotfix/…`：生產環境中的緊急修復
建立分支：
“‘重擊
git checkout -b feature/login
“
完成操作後，儲存變更：
“‘重擊
git add。
git commit -m "新增登入頁面"
“
6. 將變更推送到 GitHub
若要使其他團隊成員可以看到本地更改，請推送：
“‘重擊
git push -u origin feature/login
“
`-u` 選項使本地分支與遠端分支保持鏈接，以便後續推送只需執行 `git push` 即可。
7. 建立拉取請求 (PR) 和程式碼審查
Pull Requests（拉取請求）是 GitHub 協作的核心。 PR 讓你提議將一個特性分支合併到主分支。步驟如下：
1. 打開 GitHub 上的倉庫。
2. 選擇你剛剛推送的分支。
3. 點選「比較和拉取請求」。
4. 清楚填寫 PR 標題和描述：更改了什麼、原因、如何測試。
5. 指定審閱者（團隊成員）和標籤（例如「增強」、「缺陷」）。
程式碼審查有助於維護程式碼品質並在團隊內部傳播知識。審查人員通常會檢查以下內容：
邏輯真理
程式碼風格一致性
– 安全性（例如輸入驗證）
績效及其影響
– 測試可用性
如果有修改，貢獻者可以在同一分支中修復並再次推送；PR 將自動更新。
8. 解決衝突（合併衝突）
當兩個更改影響文件的同一部分時，就會發生衝突。為了減少衝突：
– 經常從目標分支拉取數據
明確劃分工作
進行小規模、有針對性的提交
如果在合併過程中出現衝突，您可以：
1. 拉取最新更改：
“‘重擊
git checkout feature/login
git fetch origin
git merge origin/main
“
2. Git 會標記衝突的檔案。打開這些文件，選擇正確的更改，然後：
“‘重擊
git 新增檔案名
git commit -m "解決與主分支的衝突"
git push
“
9. 利用議題進行任務管理
GitHub 的 Issues 功能非常適合記錄任務、錯誤、功能建議或討論。請使用清晰的格式：
– 具體標題（例如：「錯誤：行動端提交按鈕無回應」）
– 說明：重現步驟、預期行為、證據（螢幕截圖/日誌）
新增標籤、里程碑，並分配給負責人
透過 Issues，團隊可以擁有一個“待辦事項清單”，他們可以監控這些事項，確定優先級，並直接將其連結到 PR。
10. 專案看板和規劃里程碑
GitHub 提供專案（看板）功能，用於將工作組織成「待辦」、「進行中」和「已完成」等欄位。這有助於視覺化進度，尤其是當團隊有大量問題和 PR 時。
里程碑適用於特定的版本目標或截止日期，例如“v1.0”。您可以將問題和 PR 分組到里程碑中，以追蹤完成情況。
11. 透過儲存庫規則維護品質
為了使協作更加安全有序，請使用以下設定：
– 分支保護規則：防止直接推送到 `main`
– 合併前必須進行公關審查
– 強制性檢查狀態已通過（例如單元測試）
設定哪些人可以合併
這樣可以降低將問題代碼引入主分支的風險。
12. GitHub 上的協作最佳實踐
以下是一些許多專業團隊都在採用的最佳實踐：
1. 提交內容簡短且描述性強：易於追蹤和審查。
2. 使用分支命名約定：一致且易於閱讀。
3. 完整的 PR 描述：提及背景、變更和測試方法。
4. 使用範本：問題範本和 PR 範本可以加快處理速度。
5. 文件始終保持更新：README、CHANGELOG 和貢獻指南。
6. 清晰的溝通：使用 PR/Issue 評論進行技術討論，以便記錄討論內容。
7. 使用標籤和發布：標記穩定版本，使回滾更容易。
關閉
GitHub 不僅是一個程式碼儲存平台，更是一個完整的協作生態系統：涵蓋版本控制、討論、任務管理和程式碼審查等各個面向。透過實施基於分支的工作流程、拉取請求和問題跟踪，團隊可以更有效率地工作，減少衝突，並提升軟體品質。不妨從建立分支、定期提交拉取請求和記錄變更等簡單實踐入手。隨著時間的推移，專案協作將變得更有效率和專業。
