簡體   English   中英

是否可以在Github中為拉取請求創建自動模板?

[英]Is it possible to create an automatic template for pull requests in Github?

我想創建一個自動出現在每個拉取請求上的模板。

這可以是注釋或注釋。 理想情況下,它會顯示檢查拉取請求的指南:

- [ ] Have you done x?
- [ ] Have you done y?
- [ ] Have you done z?

任何人都可以提出這樣做​​的方法嗎?

是的,現在可以了。

將名為pull_request_template.md的文件添加到項目的根目錄:

- [ ] Have you done x?
- [ ] Have you done y?
- [ ] Have you done z?

您還可以使用相同的約定為問題創建模板。 只需將文件命名為issue_template.md

資料來源: https//github.com/blog/2111-issue-and-pull-request-templates

GitHub不允許您為在其網站上創建的拉取請求創建模板。

我們使用的解決方案是通過hub命令使用github api創建拉取請求。 我們將它包裝在一個名為makePR的腳本中,它執行以下操作:

#!/bin/bash
URL=$(hub pull-request -F PR-template.md)
echo "New PR created at $URL"
open $URL

(未經測試 - 我們的實際腳本做得更多 - 我遺漏了我認為你不需要的參數)

open命令將在MacOS上的默認瀏覽器中打開URL,您可能需要為其他平台調整此值。 打開后,您可以在Web瀏覽器中編輯標題。

GitHub現在通過PULL_REQUEST_TEMPLATE.md文件支持拉取請求模板

拉請求模板樣本

https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

不幸的是,單獨使用GitHub是不可能的。 好消息,GitHub現在支持這個! 看看接受的答案。

此外,GitHub有一個非常酷(並且有點隱藏)的功能,您可以使用它在創建新問題或拉取請求時將潛在貢獻者鏈接到某些貢獻信息。

來自Github博客的 貢獻指南

我們已經嘗試過讓每個人都這么容易。 作為維護者,您所要做的就是在存儲庫的根目錄中添加一個貢獻文件(如果您使用Markdown,則為CONTRIBUTING.md)。 然后,當貢獻者創建問題或打開拉取請求時,我們將添加指向您文件的鏈接。

GitHub截圖

現在,只要您的協作者開始參與,他們就可以輕松找到您希望他們遵循的指南。

有一個鍍鉻擴展,聲稱在這里做: https//github.com/sprintly/pull-request-template-chrome-extension

不幸的是,我無法讓它工作,但代碼看起來很簡單,可以找出並修復 - 我希望它是一個簡單的東西,由於github或chrome被更新而破壞。

它似乎只允許您為每個github pull請求使用單個模板,而不是為當前存儲庫提取正確的模板。

現在可以為問題和拉取請求創建模板。 它可以在存儲庫根目錄或.github文件夾中的ISSUE_TEMPLATEPULL_REQUEST_TEMPLATE文件中描述。

您可以在這里找到更多信息https://github.com/blog/2111-issue-and-pull-request-templates

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM