冒险村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


<<:  DAY7-PHP和MYSQL(一)

>>:  Day 04 Python 进阶

第59天~

这个得上一篇:https://ithelp.ithome.com.tw/articles/10262...

Day 03 - 下载XAMPP

想要简单且快速的使用XMAPP,只要下载XAMPP就行啦! XAMPP 非常容易安装及使用,你只需要...

Day 19 : 静态爬虫(下)

今天继续来谈论静态爬虫,昨天都在讲解文字,今天来讲讲图片的部分。常常看到一个网页中有很多漂亮的图片,...

[Android Studio] 汇入向量图档 .svg 时出现错误 <text> is not supported 的解决方式

今天因应工作上的需求 在专案中汇入 .svg 的向量图档 却出现了以下错误画面 这才发现原来这张 ....

【30天Lua重拾笔记32】进阶议题: LuaRocks & LuaDist

同步发表於个人网站 LuaRocks LuaRocks是类似npm、pip这样的套件管理工具,你可...