使用 GitHub

本 GitHub 教學以 DjangoGirls How To Contribute Tutorial。 以 Creative Commons Attribution-ShareAlike 4.0 授權條款提供。

在本教程中，我們將以 公文包 儲存庫作為連結和參考的基礎。 連結和參考資料。

開始與先決條件

若要對 BeeWare 做出貢獻，需要以下條件才能開始：

• 一個 GitHub 帳戶
• 如果是複雜的編輯，熟悉 Git 命令列 基礎 或熟悉 的應用程式 (Windows和Mac)，將您在電腦上進行的編輯推送到 GitHub。 將您在電腦上的編輯推送到 GitHub。

分叉儲存庫

首先，將 Briefcase 套件庫到您的個人 GitHub 帳戶：

<img src="/contributing/first-time/github/fork.png" class="img-fluid" alt=「Fork 按鈕」 />

編輯文件

簡單的變更

對於簡單的變更，例如錯字修正，您可以使用 GitHub 線上 編輯器：

• 在 GitHub 上開啟您的本機 fork 頁面、
• 進入任何章節的 README.rst 檔案、
• 按下 Edit 圖示 (筆)

並可直接在 github.com 上編輯該章節。

RST 語法用於編輯文件的個別頁面。

<img src="/contributing/first-time/github/github_editor.png" class="img-fluid" alt=「GitHub 編輯器」 />

注意事項

!上述截圖可能無法反映 GitHub 倉庫目前的內容。Live 倉庫會不時變更。但是，提交拉取請求的流程保持不變。

儲存您的變更，並建立一個拉取請求，如下所述。

新程式碼和複雜的變更

若要新增程式碼、擴充類別或進行複雜的變更，您需要 將程式碼複製到您的本機電腦。

使用您作業系統的 GitHub 應用程式（如上所述）或 命令行來取得本機的套件庫。您可以從自己的 地址：

git clone git@github.com:yourusername/briefcase.git

然後，為您的新變更建立一個分支。將分支稱為 與您要進行的變更相關的分支。

git checkout -b update_documentation

在程式碼中進行任何變更，並確保這些變更經過測試，並儲存在本機中。 在本地儲存。

然後使用 git 提交變更，並將變更推送到您的遠端 GitHub 倉庫。

範例：

$ git status
在分支 update_documentation 上
未追蹤的檔案：
  (使用「git add <檔案>...」加入要提交的檔案）

    README.rst

git add README.rst

$ git commit -m 「更新公文包的 README.rst 文件」
[update_documentation fe36152] 新增 gitbook 螢幕截圖
 1 檔案變更, 0 插入(+), 0 刪除(-)
 建立模式 100644 README.rst

$ git push
計數物件：11, 已完成。
最多使用 8 個執行緒進行 Delta 壓縮。
壓縮物件：100% (5/5)，完成。
寫入物件：100% (5/5), 266.37 KiB | 0 bytes/s, 已完成。
總計 5 (delta 1)，重複使用 0 (delta 0)
至 git@github.com:yourusername/briefcase.git
   b37ca59..fe36152 update_documentation -> update_documentation

提出拉取請求

完成變更之後，您需要在 上建立 a pull 請求 GitHub。BeeWare 會收到拉取請求的通知，審查您的修改，並在需要時提出修正建議。 修改，並提出修正建議。 到主版本。

在您自己的 GitHub 儲存庫中，按 比較與拉取請求。

填寫*為何要做此變更的資訊。審核員 審查員可以看到實際變更的詳細資訊，因此您不需要重複 變更的內容。

然後按 Create pull request。

GitHub 電子郵件會通知您後續程序。

---