如何準備現有專案並上傳至 GitHub?
在這個單元,我們會討論將專案上傳至 GitHub 的重要考量。
為什麼要上傳至 GitHub?
有大量文獻頌揚 GitHub 的優點,但說服您加入已經超出了本課程模組的範圍。 但在這個課程模組中,我們會回顧您在規劃上傳時,主題內容中需要考量的一些主要優點。
版本控制
GitHub 專門使用 Git,可以說是周圍最好的版本控制系統。 不過,Git 非常複雜,而且或許會建立一些複雜案例,讓您的小組必須處理不熟悉的程式碼。 「分支」與「提取要求」對於使用 Git 的開發人員而言是日常生活的基本部分,因此,需要了解有效使用這兩者的時機與方式,才能在 GitHub 上成功。 值得您的小組先熟悉 GitHub 流程 ,以便快速投入工作。
將您的程式碼保留在雲端
大量的專案程式碼仍然只會儲存於開發人員電腦上。 當您上傳至 GitHub 時,您會將程式碼移至 GitHub 的雲端平台,讓小組成員可以輕鬆地從任何地方存取。 此變更提供一個好機會,可針對您在版本控制中保留的檔案與資料種類檢閱小組的原則。 最佳做法是假設您提交給 GitHub 的任何內容都可能會遭到入侵。 因此,請確保不要包含任何敏感性資料,例如 API 金鑰、密碼或其他包含可比較資訊的檔案。
注意
GitHub 同時提供公用和私人存放庫,以及存放庫不同部分的細微訪問控制。 此數據粒度可讓您控制專案可看見的人員,以及指定使用者可以執行的動作。
共同作業
GitHub 透過問題、提取要求與程式碼檢閱等功能,為小組共同作業提供絕佳支援。 不過,GitHub 流程可能與您小組目前習慣的做法不同。 考慮您的小組會如何適應 GitHub,以及是否會保留任何現有程序,是個不錯的主意。
如果您的專案是允許外部參與者的開放原始碼專案,則不會有比 GitHub 更好的選項可發揮這些優勢。
上傳至 GitHub
計畫考量
在執行上傳至 GitHub 之前要考慮的最重要事項是,您是否需要保留任何超出來源目前狀態的內容。 例如,您可以使用試算表或專案管理軟體來追蹤您計畫修正的錯誤。 對移轉這些項目的支援會因平台而異,而且通常可從社群專案取得。 此課程模組並未涵蓋移轉那類型的資料。
處理目前儲存於專案中的二進位檔案
最佳做法是將 GitHub 存放庫限制為建置專案所需的檔案。 避免認可大型二進位檔案,例如建置成品。 試算表與簡報之類的二進位檔案更適合在入口網站上進行追蹤,以了解如何適當地為其提供服務並進行版本設定。 如果您需要版本大型二進位檔,請考慮使用 Git 擴展名 Git LFS (大型檔案記憶體)。
建立 .gitignore 之類的重要 Git 檔案
Git 支援 .gitignore 檔案,以協助強制執行版本控制檔案原則。 這些檔案會定義用來從原始程式碼控制追蹤中排除檔案與資料夾的搜尋模式。 下列範例會以遞歸方式從原始檔控制追蹤中排除 任何 稱為 Bin 或 bin 的資料夾及其內容。
[Bb]in/
深入瞭解 忽略檔案。 另請參閱 .gitignore \(英文\) 中針對各種平台提供的入門 檔案集合。
GitHub 專案中通常會使用數個其他檔案,來向存放庫取用者與參與者說明不同原則。 即使您的專案是私人且僅限於有限的對象,但明確表達這些原則仍然很有用。 儘管不需要這些檔案,但這裡列出了一些常見的檔案。
| 檔案 | 目的 |
|---|---|
README.md |
目錄的登陸頁面。 在 GitHub 上檢視其目錄時,即會呈現此頁面。 |
LICENSE.md |
此檔案包含提供程式碼的授權。 |
CONTRIBUTING.md |
說明使用者應如何參與專案,例如提取要求期望。 |
SECURITY.md |
說明專案的安全性原則。 此檔案會提供指導方針給想要提交與安全性相關的敏感性程式碼,或不應在解決前公開之意見反應的使用者。 |
深入了解 如何設定專案以促進健康的貢獻。
將您的專案上傳至 GitHub
存放庫準備好上傳之後,在 GitHub 上建立存放庫。 建立之後,瀏覽至 GitHub 存放庫的 [程式碼] 索引標籤。 這個檢視將為您提供數種方式來上傳您的專案程式碼。
建議您使用 Git 用戶端或 Git 易記工具來上傳您的來源。 或者,您可以使用 建立新的檔案 連結,手動上傳檔案。 從長遠來看,您可能會發現使用 Git 用戶端是管理變更、分支等等的最佳方式。