Github 拉取請求模板未顯示

Question

我想為我的 Github 存儲庫（我公司的內部版本，而不是 Github.com）創建自定義 Pull Requests 模板，所以我按照此鏈接上的說明進行操作。 我按照以下步驟操作：

1. 在以下位置創建了新的模板文件：[my-repo]/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md。
2. 將這個新文件合並到 master 中。
3. 從 master 創建了一個新分支，將一些更改提交到新分支。
4. 創建了一個新的 Pull Request to master，但是模板沒有出現。

創建新的 PR 沒有顯示我創建的模板。 創建新問題模板的類似步驟工作正常，但 PR 模板不起作用。 我想在 PULL_REQUEST_TEMPLATE 文件夾中添加不同的模板，以創建多個拉取請求模板，如功能模板、錯誤修復模板等。我的 PR 模板 markdown 中包含以下內容：

---
name: Design Review
about: Design Review issue template

---

# PR Change Description
This PR is to add a new vendor type.

Answer 1

您必須在存儲庫的默認分支上創建模板。 在其他分支中創建的模板無法供協作者使用。 您可以將拉取請求模板存儲在存儲庫的可見根目錄、docs 文件夾或隱藏的 .github 目錄中。 拉取請求模板文件名不區分大小寫，並且可以具有擴展名，例如 .md 或 .txt。

Answer 2

GitHub 默認會加載文件.github/PULL_REQUEST_TEMPLATE.md作為 PR 模板。

但是，可以有多個模板並使用 url 上的查詢字符串引用它們，如下所示： https://github.com/octo-org/octo-repo/compare/master...pull-request-test?template=pr_template.md : https://github.com/octo-org/octo-repo/compare/master...pull-request-test?template=pr_template.md

這將從.github/PULL_REQUEST_TEMPLATE/pr_template.md加載模板pr_template.md ，其中master是目標分支， pull-request-test是要合並的分支。

同樣對於問題

https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md

文檔在這一點上寫得不是很好，但是這里列出了 PR 創建表單的完整參數集： https : //help.github.com/en/github/managing-your-work-on-github/ about-automation-for-issues-and-pull-requests-with-query-parameters ，但它甚至有這個特定示例的錯誤網址

對於問題，現在有一個通過 yaml 配置的模板選擇器，因此您可以在不使用查詢字符串的情況下在模板之間進行選擇，也許以后 PR 會提供類似的內容https://help.github.com/en/github/building-a-strong -community/configuring-issue-templates-for-your-repository

Answer 3

您應該只在.github文件夾中創建文件，而不是PULL_REQUEST_TEMPLATE文件夾。

將您的.md文件移動到.github/PULL_REQUEST_TEMPLATE.md應該可以工作。

Answer 4

我嘗試將我的pull_request_template.md文件添加到.github/PULL_REQUEST_TEMPLATE/pull_request_template.md路徑

但它不起作用然后我將我的文件移動到.github/pull_request_template.md路徑，即刪除子目錄PULL_REQUEST_TEMPLATE並繁榮它工作。

因此，如果您沒有多個模板，那么您不需要創建PULL_REQUEST_TEMPLATE子目錄並確保在您的默認分支中創建您的pull_request_template.md ，該分支主要是master 。

Answer 5

在我的例子中，文件的名稱是.github/pull_request_template.md ，如GitHub 文檔中所述，直到我將其重命名為.github/PULL_REQUEST_TEMPLATE.md它才起作用。

PS 在此更改之前，我正在將文件移動到不同的文件夾中，因此可能是某些東西卡在了 GitHub 緩存中。

Answer 6

您可以檢查該文件是否真的<\/em>在您的\\.github<\/code>目錄中。 在我的情況下，vscode“視覺折疊” \\.github<\/code>到\\.github\\workflows<\/code>所以我不小心在\\.github\\workflows<\/code>中創建了文件。

將它移到一個目錄中，所以它確實<\/em>在\\.github<\/code>中，現在它按預期顯示。 可能很明顯，但我花了大約 10 分鍾才發現。