mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-27 12:39:49 +08:00
chore: improve pr template (#50301)
* chore: update pr template * chore: update pr template * chore: update pr template
This commit is contained in:
afc163
GitHub
parent
b13c19aa68
commit
2a877f066a
63
.github/PULL_REQUEST_TEMPLATE.md
vendored
63
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -6,51 +6,42 @@ Your pull requests will be merged after one of the collaborators approve.
|
||||
Thank you!
|
||||
-->
|
||||
|
||||
[中文版模板 / Chinese template](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE/pr_cn.md?plain=1)
|
||||
[中文版模板 / Chinese template](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE_CN.md?plain=1)
|
||||
|
||||
### 🤔 This is a ...
|
||||
|
||||
- [ ] New feature
|
||||
- [ ] Bug fix
|
||||
- [ ] Site / documentation update
|
||||
- [ ] Demo update
|
||||
- [ ] Component style update
|
||||
- [ ] TypeScript definition update
|
||||
- [ ] Bundle size optimization
|
||||
- [ ] Performance optimization
|
||||
- [ ] Enhancement feature
|
||||
- [ ] Internationalization
|
||||
- [ ] Refactoring
|
||||
- [ ] Code style optimization
|
||||
- [ ] Test Case
|
||||
- [ ] Branch merge
|
||||
- [ ] Workflow
|
||||
- [ ] Other (about what?)
|
||||
- [ ] 🆕 New feature
|
||||
- [ ] 🐞 Bug fix
|
||||
- [ ] 📝 Site / documentation improvement
|
||||
- [ ] 📽️ Demo improvement
|
||||
- [ ] 💄 Component style improvement
|
||||
- [ ] 🤖 TypeScript definition improvement
|
||||
- [ ] 📦 Bundle size optimization
|
||||
- [ ] ⚡️ Performance optimization
|
||||
- [ ] ⭐️ Feature enhancement
|
||||
- [ ] 🌐 Internationalization
|
||||
- [ ] 🛠 Refactoring
|
||||
- [ ] 🎨 Code style optimization
|
||||
- [ ] ✅ Test Case
|
||||
- [ ] 🔀 Branch merge
|
||||
- [ ] ⏩ Workflow
|
||||
- [ ] ❓ Other (about what?)
|
||||
|
||||
### 🔗 Related issue link
|
||||
### 🔗 Related Issues
|
||||
|
||||
<!--
|
||||
1. Put the related issue or discussion links here.
|
||||
2. close #xxxx or fix #xxxx for instance.
|
||||
-->
|
||||
> - Describe the source of related requirements, such as links to relevant issue discussions.
|
||||
> - For example: close #xxxx, fix #xxxx
|
||||
|
||||
### 💡 Background and solution
|
||||
### 💡 Background and Solution
|
||||
|
||||
<!--
|
||||
1. Describe the problem and the scenario.
|
||||
2. GIF or snapshot should be provided if includes UI/interactive modification.
|
||||
3. How to fix the problem, and list the final API implementation and usage sample if that is a new feature.
|
||||
-->
|
||||
> - The specific problem to be addressed.
|
||||
> - List the final API implementation and usage if needed.
|
||||
> - If there are UI/interaction changes, consider providing screenshots or GIFs.
|
||||
|
||||
### 📝 Changelog
|
||||
### 📝 Change Log
|
||||
|
||||
<!--
|
||||
Describe changes from the user side, and list all potential break changes or other risks.
|
||||
--->
|
||||
|
||||
- Use a developer-oriented tone and narrative style.
|
||||
- Describe the user's first-hand experience of the issue and its impact on developers, rather than your solution approach.
|
||||
- Refer to: https://ant.design/changelog
|
||||
> - Describe the impact of the changes on developers, not the solution approach.
|
||||
> - Reference: https://ant.design/changelog
|
||||
|
||||
| Language | Changelog |
|
||||
| ---------- | --------- |
|
||||
|
||||
58
.github/PULL_REQUEST_TEMPLATE/pr_cn.md
vendored
58
.github/PULL_REQUEST_TEMPLATE/pr_cn.md
vendored
@ -1,58 +0,0 @@
|
||||
<!--
|
||||
首先，感谢你的贡献！😄
|
||||
|
||||
新特性请提交至 feature 分支，其余可提交至 master 分支。
|
||||
在维护者审核通过后会合并。
|
||||
请确保填写以下 pull request 的信息，谢谢！~
|
||||
-->
|
||||
|
||||
[English Template / 英文模板](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1)
|
||||
|
||||
### 🤔 这个变动的性质是？
|
||||
|
||||
- [ ] 新特性提交
|
||||
- [ ] 日常 bug 修复
|
||||
- [ ] 站点、文档改进
|
||||
- [ ] 演示代码改进
|
||||
- [ ] 组件样式/交互改进
|
||||
- [ ] TypeScript 定义更新
|
||||
- [ ] 包体积优化
|
||||
- [ ] 性能优化
|
||||
- [ ] 功能增强
|
||||
- [ ] 国际化改进
|
||||
- [ ] 重构
|
||||
- [ ] 代码风格优化
|
||||
- [ ] 测试用例
|
||||
- [ ] 分支合并
|
||||
- [ ] 工作流程
|
||||
- [ ] 其他改动（是关于什么的改动？）
|
||||
|
||||
### 🔗 相关 Issue
|
||||
|
||||
<!--
|
||||
1. 描述相关需求的来源，如相关的 issue 讨论链接。
|
||||
2. 例如 close #xxxx、 fix #xxxx
|
||||
-->
|
||||
|
||||
### 💡 需求背景和解决方案
|
||||
|
||||
<!--
|
||||
1. 要解决的具体问题。
|
||||
2. 列出最终的 API 实现和用法。
|
||||
3. 涉及UI/交互变动需要有截图或 GIF。
|
||||
-->
|
||||
|
||||
### 📝 更新日志
|
||||
|
||||
<!--
|
||||
从用户角度描述具体变化，以及可能的 breaking change 和其他风险。
|
||||
-->
|
||||
|
||||
- 请用面向开发者的角度和叙述方式撰写 changelog
|
||||
- 描述用户第一现场的问题，对开发者有哪些影响，而非你的解决方式
|
||||
- 参考：https://ant.design/changelog-cn
|
||||
|
||||
| 语言 | 更新描述 |
|
||||
| ------- | -------- |
|
||||
| 🇺🇸 英文 | |
|
||||
| 🇨🇳 中文 | |
|
||||
49
.github/PULL_REQUEST_TEMPLATE_CN.md
vendored
Normal file
49
.github/PULL_REQUEST_TEMPLATE_CN.md
vendored
Normal file
@ -0,0 +1,49 @@
|
||||
<!--
|
||||
首先，感谢你的贡献！😄
|
||||
|
||||
新特性请提交至 feature 分支，其余可提交至 master 分支。
|
||||
在维护者审核通过后会合并。
|
||||
请确保填写以下 pull request 的信息，谢谢！~
|
||||
-->
|
||||
|
||||
[English Template / 英文模板](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1)
|
||||
|
||||
### 🤔 这个变动的性质是？
|
||||
|
||||
- [ ] 🆕 新特性提交
|
||||
- [ ] 🐞 Bug 修复
|
||||
- [ ] 📝 站点、文档改进
|
||||
- [ ] 📽️ 演示代码改进
|
||||
- [ ] 💄 组件样式/交互改进
|
||||
- [ ] 🤖 TypeScript 定义更新
|
||||
- [ ] 📦 包体积优化
|
||||
- [ ] ⚡️ 性能优化
|
||||
- [ ] ⭐️ 功能增强
|
||||
- [ ] 🌐 国际化改进
|
||||
- [ ] 🛠 重构
|
||||
- [ ] 🎨 代码风格优化
|
||||
- [ ] ✅ 测试用例
|
||||
- [ ] 🔀 分支合并
|
||||
- [ ] ⏩ 工作流程
|
||||
- [ ] ❓ 其他改动（是关于什么的改动？）
|
||||
|
||||
### 🔗 相关 Issue
|
||||
|
||||
> 1. 描述相关需求的来源，如相关的 issue 讨论链接。
|
||||
> 2. 例如 close #xxxx、 fix #xxxx
|
||||
|
||||
### 💡 需求背景和解决方案
|
||||
|
||||
> 1. 要解决的具体问题。
|
||||
> 2. 列出最终的 API 实现和用法。
|
||||
> 3. 涉及UI/交互变动建议提供截图或 GIF。
|
||||
|
||||
### 📝 更新日志
|
||||
|
||||
> - 描述改动对开发者有哪些影响，而非解决方式
|
||||
> - 可参考：https://ant.design/changelog-cn
|
||||
|
||||
| 语言 | 更新描述 |
|
||||
| ------- | -------- |
|
||||
| 🇺🇸 英文 | |
|
||||
| 🇨🇳 中文 | |
|
||||
Loading…
Reference in New Issue
Block a user