wuba / Picasso

一款UI自动生成代码插件,提供UI自动生成代码全流程解决方案。
https://picassoui.58.com
MIT License
1.13k stars 175 forks source link

Create pull_request_template.md #27

Closed zhiqingchen closed 2 years ago

zhiqingchen commented 2 years ago

这个变动的性质是

需求背景

  1. 描述相关需求的来源。
  2. 要解决的问题。
  3. 相关的 issue 讨论链接。

使用github提供的模板 https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

代替 https://github.com/wuba/Picasso/wiki/PR-%E8%A7%84%E8%8C%83#pull-request-%E6%A8%A1%E6%9D%BF

实现方案和 API

  1. 基本的解决思路和其他可选方案。
  2. 列出最终的 API 实现和用法。
  3. 涉及UI/交互变动需要有截图或 GIF。

对用户的影响和可能的风险

  1. 这个改动对用户端是否有影响?影响的方面有哪些?
  2. 预期的 changelog 要怎么写?
  3. 是否有可能隐含的 break change 和其他风险?

请求合并前的自查清单

后续计划

如果这个提交后面还有相关的其他提交和跟进信息,可以写在这里。

SunilWang commented 2 years ago

你提交的规范,跟我wiki里面的没有任何区别啊?

zhiqingchen commented 2 years ago

就是加了pull request templete,这样pr就会默认带上这些内容,开发者只有进行修改

SunilWang commented 2 years ago

@zhiqingchen 非常感谢