GitHub 使用指南：開發者不可或缺的工具

ShiC丶發表於2024-05-28
Github

GitHub 詳細介紹

GitHub 是一個全球知名的程式碼託管和版本控制平臺，廣泛用於軟體開發和協作。它基於 Git 版本控制系統，提供了大量功能，幫助開發者高效地管理程式碼和專案。

一、GitHub 基本概念

  1. Git：一個分散式版本控制系統，Git可以跟蹤和記錄檔案的每一次更改，這樣你就可以檢視檔案的歷史版本，瞭解每次更改的內容，以及誰做了這些更改。
    協作：Git允許多人同時在同一個專案上工作。每個人都可以在自己的本地環境中進行更改，然後將這些更改推送到共享的程式碼庫。這使得團隊成員可以並行工作，而不會互相干擾。
    分支管理：Git的分支功能允許你建立專案的不同版本，這樣你可以在不影響主線（master branch）的情況下進行實驗和開發新功能。
    回滾：如果你發現一個錯誤，或者想要撤銷某些更改，Git提供了回滾功能，可以讓你輕鬆地回到之前的狀態。
  2. Repository (Repo)：在GitHub中，Repository（通常簡稱為Repo）是用來儲存和管理程式碼的地方。每個Repository都包含了專案的所有檔案、版本歷史和相關資源。你可以在Repository中討論並管理工作。
    每個GitHub Repository都具有唯一的URL地址，並作為一個獨立的實體存在。Repository可以被克隆（Clone）、下載（Download）和提交（Commit）等操作。
    在分散式版本管理系統中，每個使用者端都會儲存有各自的一份程式碼，同時客戶之間還有一個伺服器，與這個伺服器相連所有的使用者端都可向伺服器上推送（push）和拉取（pull）程式碼，以便於更新伺服器中的程式碼版本或者從伺服器上下載程式碼到本地。伺服器上的程式碼要用一個倉庫（repo）來儲存，這個在雲端的倉庫就叫遠端倉庫；而在我們自己本地的倉庫就叫做本地倉庫。
  3. Commit：在GitHub中，commit是指對程式碼進行的一次提交或者修改的記錄。每次commit都會記錄下相關的修改資訊，包括作者、日期、修改內容等。
    在版本控制系統的概念中，commit是指將一組修改或更改應用到程式碼庫中的行為。在GitHub中，commit是開發者將程式碼更改儲存到程式碼庫的方式。
    具體來說，當你在GitHub上對程式碼進行修改時，你可以使用git add命令將修改的檔案新增到暫存區，然後使用git commit命令將暫存區的內容提交到本地倉庫。這個過程就是一個commit。
    每個commit都會生成一個唯一的識別符號，這樣你就可以輕鬆地跟蹤和檢視每個commit的詳細資訊，包括它是何時建立的，誰建立的，以及具體修改了哪些內容。
  4. Branch：在GitHub中，branch（分支）是用於並行開發和版本控制的重要工具。
    並行開發：branch允許你在不影響主線（通常是master分支）的情況下進行獨立的開發工作。這意味著你可以在自己的分支上進行修改，新增和刪除程式碼，然後將這些更改合併到主分支或其他分支。
    版本控制：每個branch都是程式碼庫的一個版本。當你建立一個新的branch時，它會從現有的程式碼庫中複製一份副本，你可以在這個副本上進行修改。
    合併更改：當你在一個branch上完成了修改後，你可以使用git merge命令將這個branch的更改合併到主分支或其他分支。
    實驗新功能：branch也常被用於實驗新功能。你可以在一個新的branch上開發新功能，如果實驗成功，就可以將這個branch合併到主分支；如果實驗失敗，你可以選擇丟棄這個branch，而不會影響主分支。
  5. Merge：在GitHub中，merge（合併）是一個非常重要的操作，它用於將一個分支的更改合併到另一個分支。
    整合更改：當你在不同的分支上開發不同的功能時，可以使用git merge將這些分支的更改合併在一起，以形成一個新的共同版本。
    解決衝突：如果在兩個不同的分支中，對同一個檔案的同一個部分進行了不同的修改，Git就無法自動地合併它們，而是會暫停合併過程，等待你去手動解決衝突。
    建立新的提交：一旦所有的衝突都被解決，你可以使用git commit命令來完成合並，並建立一個新的提交。
  6. Pull Request (PR)：在GitHub中，Pull Request（簡稱PR）是一種通知機制，用於將你對他人程式碼的修改通知原來的作者，並希望他合併你的修改。Pull Request本質上是一種軟體的合作方式，是將涉及不同功能的程式碼，納入主幹的一種流程。
    例如，一個名為A的使用者復刻了一個屬於B的倉庫並對其做了一些變更，A可以向B發起一個拉取請求，不過是否接受取決於B。這就好像是在說：“B，你可以拉取我所做的變更嗎？”。
    在開源專案中，Pull Request被廣泛用於參與社群貢獻，從而促進專案的發展。當發現專案的漏洞或想要新增新功能時，外部開發者可以在自己的分支上進行修改，並透過Pull Request將更改提交給專案維護者2。維護者會對更改進行審查，並根據專案的需求和規範決定是否合併這些更改。
    Pull Request是GitHub中用於版本控制和協作的關鍵操作，它使得多人同時在同一個專案上工作成為可能，而且各自的工作不會互相干擾。

二、GitHub 的主要功能

  1. 程式碼託管：

    • 私有和公共倉庫：支援建立私有或公共倉庫，管理程式碼版本。
    • 大檔案支援：透過 Git LFS 支援大檔案儲存。

  2. 協作工具：

    • Issue：用於跟蹤錯誤、任務、討論等。
    • Projects：看板工具，管理專案進度和任務。
    • Wiki：為專案建立文件和知識庫。

  3. 程式碼審查和合並：

    • Pull Request：提交程式碼變更請求，進行程式碼審查和討論。
    • Reviewers：分配審查人員，提供程式碼審查意見。
    • Merge Strategies：多種合併策略，如合併提交、壓縮合並等。

  4. CI/CD 整合：

    • GitHub Actions：內建持續整合/持續部署（CI/CD）工具，自動化構建、測試、部署流程。
    • Marketplace：整合第三方工具和服務，擴充套件 CI/CD 能力。

  5. 安全和合規：

    • Dependabot：自動檢查和更新依賴項，修復安全漏洞。
    • Security Advisories：報告和修復安全漏洞，保護程式碼安全。

  6. 社群和發現：

    • Explore：發現熱門專案和開發者。
    • Topics：根據主題分類專案，方便查詢相關資源。

三、GitHub 的使用步驟

  1. 註冊和建立倉庫：

    • 訪問 GitHub，註冊賬戶。
    • 建立新倉庫，選擇倉庫名稱、描述、私有或公共設定。

  2. 克隆和提交程式碼：

    • 使用 Git 命令列或 GitHub Desktop 克隆倉庫到本地。
    • 進行程式碼開發，使用 git add、git commit 提交程式碼變更。
    • 使用 git push 將本地變更推送到遠端倉庫。

  3. 分支和合並：

    • 建立新分支：git checkout -b new-branch。
    • 開發完成後，提交變更並推送分支：git push origin new-branch。
    • 在 GitHub 上建立 Pull Request，請求程式碼審查和合並。

  4. 程式碼審查和討論：

    • 分配審查人員，進行程式碼審查和討論。
    • 審查透過後，合併 Pull Request，刪除分支。

  5. 自動化和整合：

    • 配置 GitHub Actions，實現自動化構建、測試、部署。
    • 整合第三方工具，如 CI/CD、程式碼質量檢查等。

四、GitHub 的優勢

  1. 廣泛使用：全球開發者廣泛使用的程式碼託管平臺，支援多種程式語言和框架。
  2. 強大的協作功能：提供全面的協作工具，支援團隊高效合作。
  3. 豐富的整合：支援與多種工具和服務整合，擴充套件開發流程。
  4. 社群資源：龐大的開源社群，豐富的專案和資源可供學習和借鑑。
  5. 安全保障：內建多種安全工具和策略，保障程式碼安全。

五、GitHub 高階功能和技巧

  1. GitHub Pages：免費託管靜態網站，用於專案文件、個人部落格等。
  2. Actions Marketplace：瀏覽和使用社群建立的 GitHub Actions，實現自動化任務。
  3. Code Owners：設定程式碼所有者，指定特定檔案或目錄的審查人員。
  4. GitHub Sponsors：支援開源專案開發者，透過捐助支援專案發展。
  5. API 和 Webhooks：透過 API 和 Webhooks 與其他工具和服務整合，實現自動化和自定義功能。

六、結論

GitHub 是一個功能強大、易於使用的程式碼託管和協作平臺，適用於個人開發者、小型團隊和大型企業。透過掌握 GitHub 的基本概念、主要功能和使用步驟，開發者可以高效地管理程式碼、協作開發，並利用豐富的工具和資源提升開發效率和質量。

相關文章