diff --git a/.github/PULL_REQUEST_TEMPLATE/pr_cn.md b/.github/PULL_REQUEST_TEMPLATE/pr_cn.md new file mode 100644 index 00000000..dc71a981 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pr_cn.md @@ -0,0 +1,61 @@ + + +[[English Template / 英文模板](https://github.com/toimc-team/vue3-toimc-admin/blob/main/.github/PULL_REQUEST_TEMPLATE.md)] + +### 🤔 这个变动的性质是? + +- [ ] 新特性提交 +- [ ] 日常 bug 修复 +- [ ] 站点、文档改进 +- [ ] 演示代码改进 +- [ ] 组件样式/交互改进 +- [ ] TypeScript 定义更新 +- [ ] 包体积优化 +- [ ] 性能优化 +- [ ] 功能增强 +- [ ] 国际化改进 +- [ ] 重构 +- [ ] 代码风格优化 +- [ ] 测试用例 +- [ ] 分支合并 +- [ ] 其他改动(是关于什么的改动?) + +### 🔗 相关 Issue + + + +### 💡 需求背景和解决方案 + + + +### 📝 更新日志 + + + +| 语言 | 更新描述 | +| ------- | -------- | +| 🇺🇸 英文 | | +| 🇨🇳 中文 | | + +### ☑️ 请求合并前的自查清单 + +⚠️ 请自检并全部**勾选全部选项**。⚠️ + +- [ ] 文档已补充或无须补充 +- [ ] 代码演示已提供或无须提供 +- [ ] TypeScript 定义已补充或无须补充 +- [ ] Changelog 已提供或无须提供 \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 82692117..42098334 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,34 +1,61 @@ -### `General` - -> ✏️ Mark the necessary items without changing the structure of the PR template. - -- [ ] Pull request template structure not broken - -### `Type` - -> ℹ️ What types of changes does your code introduce? - -> 👉 _Put an `x` in the boxes that apply_ - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update - -### `Checklist` - -> ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in [CONTRIBUTING](contributing.md). - -> 👉 _Put an `x` in the boxes that apply._ - -- [ ] My code follows the style guidelines of this project -- [ ] Is the code format correct -- [ ] Is the git submission information standard? -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules + + +[[中文版模板 / Chinese template](https://github.com/toimc-team/vue3-toimc-admin/blob/main/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)] + +### 🤔 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 +- [ ] Other (about what?) + +### 🔗 Related issue link + + + +### 💡 Background and solution + + + +### 📝 Changelog + + + +| Language | Changelog | +| ---------- | --------- | +| 🇺🇸 English | | +| 🇨🇳 Chinese | | + +### ☑️ Self Check before Merge + +⚠️ Please check all items below before review. ⚠️ + +- [ ] Doc is updated/provided or not needed +- [ ] Demo is updated/provided or not needed +- [ ] TypeScript definition is updated/provided or not needed +- [ ] Changelog is provided or not needed \ No newline at end of file