優化 GitHub 上的專案工作：熟悉 Github 範本儲存庫

大家好，JavaRush 社群！ 今天我們將討論開源以及除了編寫的程式碼之外 創建高品質專案所需的條件。編寫一個有用的產品很重要。但同樣重要的是儲存庫（GitHub 上的專案儲存庫）的正確設計。這將有助於實現另一個關鍵點——產品推廣。即使這個專案超級酷，但如果它設計得很差，至少在自述文件中沒有描述（你可以在這裡閱讀自述文件是什麼），沒有註明許可證等等，就會有沒有成功。只是沒人會注意到他。如果有人注意到，他們將不知道如何與他互動。有很多東西需要一遍又一遍地填寫，對於程式設計師來說每次複製貼上並不容易，而正是為了這個，今年夏天，GitHub 發布了Template Repository功能來幫助解決這個問題。可以說，自動化創建新專案的過程。今天我們將了解什麼是儲存庫以及什麼是範本儲存庫。我們將描述專案中除了程式碼之外還應該有什麼，需要注意什麼。讓我們從頭開始建立一個模板儲存庫，並添加我認為必要的所有內容。最後，我們將在建立新儲存庫時使用範本儲存庫。但首先，讓我們先了解這些術語。 理論：任何專案的通用儲存庫中應該包含什麼GitHub 上的每個開源專案都應該有一個詳細描述的社群簡介，其中包含以下元素。

1. 問題模板

在這裡，您需要描述在儲存庫中建立問題的規則：它們應該被稱為什麼，標籤是什麼，誰將被指派給它。建立新問題時，將提供以下選項：

• 錯誤回報- 建立問題來描述專案中的缺陷；
• 功能請求- 專案新想法的提案；
• 改進請求－對專案的改進建議；
• 自訂問題範本- 如果其他選項不起作用，您可以使用空白範本。

可以在此處查看其外觀的範例。

2. 許可證

編寫專案所依據的許可證。有必要讓使用該專案的人知道什麼是有保證的，什麼是沒有保證的。例如，Apache 許可證 2.0規定如下：

3.自述文件

這是該項目的描述，它的名片。關於該項目需要說明的所有內容都應該在這裡。當然，考慮到項目的具體情況，每次都需要對其進行描述，但標題是相同的。例如：

• 概述－項目的簡要描述；
• 使用 - 如何使用該項目；
• 建設－如何啟動一個項目，需要什麼；
• 故障排除 - 這描述了您可能遇到的問題以及如何解決這些問題；
• 發行說明 - 根據版本進行更改的說明；
• 作者－不要忘記你所愛的人；
• 貢獻 - 描述您如何參與專案的開發；
• 行為準則 - 參與規則的描述；
• RELEASE_NOTES - 記錄新版本的所有變更的檔案。最好將其放在單獨的文檔中並在自述文件中儲存連結；
• CONTRIBUTING是一個文件，描述您如何為該專案的開發做出貢獻。為 README 中的 Contributing 標頭製作一個單獨的檔案；
• CODE_OF_CONDUCT - 描述參與專案開發的規則的文件；
• 拉取請求範本- 供創建拉取請求的人使用的範本。

所有這些東西都在不同的項目中使用，無論程式語言或其具體細節如何。

練習：創建自己的模板

正如他們所說，讓我們從言語轉向行動。現在，我將透過一個範例向您展示如何建立自己的模板。

1. 您首先需要在 GitHub 上擁有一個帳戶/在那裡註冊。

2. 建立新儲存庫：為此，請點擊右上角的 +

3. 創建時填寫：

   • 儲存庫名稱 - 在我的例子中儲存庫範本；
   • 描述－項目的簡要描述；
   • 我們離開公共，儘管您可以選擇私人；
   • 檢查 README 初始化框：

   • 選擇項目將遵循的許可證：

     由於就我而言，模板是通用的，因此不需要 gitignore：它將針對特定項目和程式語言添加。

     因此，點擊建立儲存庫，從而完成建立過程。系統會自動帶我們到新建立的儲存庫。

4. 填寫社群資料：在建立的儲存庫中，前往「見解」標籤並選擇「社群」：

   如您所見，剩下的就是填寫行為準則、貢獻、問題範本、拉取請求範本。

   以行為準則為例，我們將展示如何將它們新增至專案。

   點擊新增，系統提示您選擇貢獻者契約或公民行為準則：

   我選擇第一個並點擊Review and Submit。

   接下來，您可以編輯該文件並提交它。

   在底部，選擇直接提交到主分支選項，然後按一下提交新檔案：

   因此，如果我們返回社區簡介，我們會發現行為準則被標記為已添加：

   Contributing 和 Issue Template 的新增方式類似，所以我就不展示了。自己做 ;）

5. 新增拉取請求範本。

   但我們要單獨談談這個問題。

   我不知道為什麼 GitHub 沒有添加同樣方便的選項來設定 Pull-Request 模板，所以你必須研究文件並 手動新增。

   為此，請按一下儲存庫根目錄中的「建立新檔案」：

   檔案名稱應為：.github/pull_request_template.md。

   我們將需要的內容新增到範本中，然後按一下「提交新檔案」，就像我們上面所做的那樣。我不打算重新發明輪子，而是找到了一個對我來說似乎非常有用的例子。

   這樣整個社區資料將會被填寫：

6. 新增模板存儲庫標記。

   為此，請轉到儲存庫中的“設定”選項，然後選取“範本儲存庫”方塊：

   就這樣，建立新專案的範本就準備好了。這樣，當我們將來需要建立新專案時，就會節省大量時間。這也將幫助您不錯過重要的細節，因為您經常忘記添加某些內容，例如許可證或問題的清晰模板。

如何使用範本儲存庫

有兩種使用選擇：

1. 當範本由您直接擁有時：建立新儲存庫時，您將可以選擇從您擁有的範本清單中的範本進行建立：

2. 當模板是外國的時：這裡也沒有什麼特殊問題。轉到該模板並點擊“使用此模板”按鈕。這裡我將使用官方文件中的動畫：

讓我們總結一下

在這篇文章中，我們研究了：

• 什麼是 GitHub 儲存庫；
• 什麼是模板儲存庫；
• 模板儲存庫中應包含哪些內容；
• 如何建立範本儲存庫；
• 如何使用範本儲存庫。

當然，基於這個模板，您已經可以建立更具體的模板。例如，我使用已配置的Maven或gradle建置系統建立了更多範本。更進一步：您可以基於後兩個建立一個 Spring Boot 儲存庫範本。為了對所有範本進行分組，我在 GitHub 上建立了一個包含所有範本的 範本儲存庫組織。訂閱我的GitHub 帳戶

有用的連結

• 包含我所建立的所有範本的組織
• GitHub 部落格：使用儲存庫模板產生新儲存庫如何為儲存庫建立模板
• GitHub 幫助：關於儲存庫，了解儲存庫是什麼。
• GitHub 幫助：從範本建立儲存庫如何基於範本建立新項目
• GitHub 幫助：許可專案許可的儲存庫描述
• GitHub 幫助：建立建立儲存庫的儲存庫描述
• 開源指南創建/描述開源專案的技巧。
• GitHub 幫助：新增拉取請求範本- 為拉取請求建立範本。

更多我的文章

• Intellij IDEA 中的調試：初學者指南
• 為 Skyscanner API 建立客戶端並將其發佈到 jCenter 和 Maven Central 的指南 [第 1 部分]
• 為 Skyscanner API 建立客戶端並將其發佈到 jCenter 和 Maven Central 的指南 [第 2 部分]
• 建立機票價格監控系統：逐步指南 [第 1 部分]
• 建立機票價格監控系統：逐步指南 [第 2 部分]
• 建立機票價格監控系統：逐步指南 [第 3 部分]
• 日誌記錄：什麼、如何、在哪裡、用什麼？
• 面試測驗如何變成開源庫
• 成功史。每週 20 小時的程式設計、碩士學位和個人生活
• 如何找工作？投遞履歷的技巧