iT邦幫忙

2021 iThome 鐵人賽

DAY 4
0
自我挑戰組

冒險村-30 Day Ruby on Rails Tips Challenge系列 第 4

冒險村04 - Create PR with default template

04 - Create PR with default template

在 Github 多人開發協作時,不同的工程師發的 Pull Requests 描述也寫的不ㄧ樣,而寫的方式如果每個人都有自己的風格,對於 Reviewers 來說負擔其實也滿大,也有可能因為 PR 寫的不完整造成更多的溝通成本。

除了能統一團隊的撰寫模式外,也可以將每次都會寫到相同的文字設定成 template 來節省時間,像是這個 PR 解決了哪個 issue、測試的 link 在以下、release 之後要注意什麼?

先建立 .github folder(與 app 資料夾同層),並在該資料夾下建立 pull_request_template.md file 撰寫內容。

Setting pull_request_template.md

This PR resolved issue #issue_code

### testing link
> url

### screenshot
> image

### Notes

Before submitting the PR make sure the following are checked:

- [ ] The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
 Wrote good commit messages.
- [ ] Commit message starts with [ithome13#issue-number] (if the related issue exists).
- [ ] Feature branch is up-to-date with master (if not - rebase it).
- [ ] Added tests.

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

### Before deploy

- [ ] todo

### After deploy

- [ ] todo

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

註: 以上 PR template 僅供參考,可以依照團隊決定最適合的方式來制訂,方便 Reviewers 快速理解 issue 及為什麼這樣子撰寫為主,更能增加團隊協作的效率。

merge 近 main branch 後,之後的 PR 都會有這個 file 的預設格式,也方便之後每個 PR 都能有一個公版,是不是既簡單又方便呀!

參考來源

My blog


上一篇
冒險村03 - Travis CI cookbook
下一篇
冒險村05 - Release Drafter
系列文
冒險村-30 Day Ruby on Rails Tips Challenge30

尚未有邦友留言

立即登入留言