如何讓 GitHub 每個 pull request (PR) 有預設模板

被端走的小菜
3 min readJul 11, 2020

--

本文章同步發表於小菜的 Blog https://riverye.com/

說明

當多人在 GitHub 開發協作,你要發 pull request (以下簡稱 PR ) 時,如果能有個預設範本 (default template) 的話,能節省一些時間,確保自己是否有遺漏該先檢查的事項,也能讓大家有共同的公版,避免格式不一致的問題。

步驟

1. 開始前,先看下預設 PR 是長這樣

2. 在專案根目錄底下新增 .github 資料夾,裡面放 pull_request_template.md 檔案,並撰寫想要的預設範本 (支援 Markdown 語法)

# 參考範例:

**將這支 PR 所做的事情,取代這段文字,描述越詳細越好。**

-----------------

與這支 PR 有關聯的 Trello 卡片:

URL: https://trello.com/c/xyzAbC

提交 PR 前,請先檢查以下是否已完成:

* [ ] 該分支是從最新 `master` 切出來 (如果不是,請先 rebase/merge 它)
* [ ] 是否新增測試,或被現有的測試覆蓋
* [ ] 這支 PR 是否有明確的標題、內容描述

-----------------

補充說明:

3. 發 PR 並 merge 到 base (通常預設是 master)

4. 接下來每個 PR 都會有預設範本囉

範例: https://github.com/River-Ye/demo-pull-request-template/pull/2

小結

有了公版範本後,能將團隊約定的事項先寫好,避免發 PR 前有丟三落四的情況發生。

範例

參考文件

Creating a pull request template for your repository

--

--

被端走的小菜
被端走的小菜

Written by 被端走的小菜

大家好,我是被端走的小菜。以個人部落格更新為主:https://riverye.com/

No responses yet