From 39b1290a3f99108cc26cbcc8324ae3a824a699db Mon Sep 17 00:00:00 2001 From: tbphp Date: Wed, 16 Jul 2025 09:05:51 +0800 Subject: [PATCH] docs: github template --- .github/ISSUE_TEMPLATE/bug_report.md | 54 ++++++++----------- .github/ISSUE_TEMPLATE/feature_request.md | 39 ++++++-------- .github/pull_request_template.md | 66 +++++------------------ 3 files changed, 51 insertions(+), 108 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a0d66be..f8ed2cc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,42 +1,34 @@ --- -name: Bug report -about: Create a report to help us improve -title: "[BUG] " -labels: "bug" +name: 报告问题 (Bug Report) +about: 使用简练详细的语言描述你遇到的问题 (Describe the bug in detail) +title: "" +labels: bug assignees: "" --- -**Describe the bug** -A clear and concise description of what the bug is. +**例行检查 / Checklist** + +- [ ] 我已确认目前没有类似 issue (I have checked for similar issues) +- [ ] 我已确认我已升级到最新版本 (I have updated to the latest version) +- [ ] 我已完整查看过项目 README，尤其是常见问题部分 (I have read the README, especially the FAQ section) +- [ ] 我理解并愿意跟进此 issue，协助测试和提供反馈 (I am willing to follow up on this issue, assist with testing, and provide feedback) +- [ ] 我理解并认可上述内容，并理解项目维护者精力有限，**不遵循规则的 issue 可能会被无视或直接关闭** (I understand and agree to the above, and I understand that the maintainers have limited time, so **issues that do not follow the rules may be ignored or closed directly**) -**To Reproduce** -Steps to reproduce the behavior: +--- -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**问题描述 / Bug Description** + -**Expected behavior** -A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**复现步骤 / Steps to Reproduce** + +1. +2. +3. -**Environment (please complete the following information):** +**预期结果 / Expected Behavior** + -- OS: [e.g. macOS, Windows, Linux] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] -- Node.js version: [e.g. 18.x] -- Package manager: [e.g. pnpm, npm, yarn] -**Additional context** -Add any other context about the problem here. - -**Logs** -Please include any relevant logs: - -``` -paste logs here -``` +**相关截图 / Screenshots** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index fb51721..f912cb9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,31 +1,24 @@ --- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE] " -labels: "enhancement" +name: 功能请求 (Feature Request) +about: 使用简练详细的语言描述希望加入的新功能 (Suggest an idea for this project) +title: "" +labels: enhancement assignees: "" --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**例行检查 / Checklist** + +- [ ] 我已确认目前没有类似 issue (I have checked for similar issues) +- [ ] 我已确认我已升级到最新版本 (I have updated to the latest version) +- [ ] 我已完整查看过项目 README，已确定现有版本无法满足需求 (I have read the README and confirmed the current version does not meet my needs) +- [ ] 我理解并愿意跟进此 issue，协助测试和提供反馈 (I am willing to follow up on this issue, assist with testing, and provide feedback) +- [ ] 我理解并认可上述内容，并理解项目维护者精力有限，**不遵循规则的 issue 可能会被无视或直接关闭** (I understand and agree to the above, and I understand that the maintainers have limited time, so **issues that do not follow the rules may be ignored or closed directly**) -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +--- -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**功能描述 / Feature Description** + -**Additional context** -Add any other context or screenshots about the feature request here. -**Implementation details (if applicable)** - -- Affected components: -- Potential breaking changes: -- Dependencies: - -**Would you like to work on this feature?** - -- [ ] Yes, I would like to implement this feature -- [ ] I need help with implementation -- [ ] I prefer someone else to implement this +**应用场景 / Use Case** + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c68fa62..7d18736 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,58 +1,16 @@ ---- -name: Pull Request -about: Submit a pull request to contribute to the project -title: "" -labels: "" -assignees: "" ---- +### 关联 Issue / Related Issue + +Closes # -## Description +### 变更内容 / Change Content + +- [ ] Bug 修复 / Bug fix +- [ ] 新功能 / New feature +- [ ] 其他改动 / Other changes -Please include a summary of the change and which issue is fixed. Include relevant motivation and context. + -Fixes # (issue) -## Type of change - -Please select the relevant options: - -- [ ] 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 -- [ ] Performance improvement -- [ ] Code refactoring -- [ ] Test updates - -## Testing - -Please describe the tests that you ran to verify your changes: - -- [ ] Unit tests pass -- [ ] Integration tests pass -- [ ] Manual testing completed - -Test Configuration: - -- Node.js version: -- Browser(s): -- OS: - -## Checklist - -- [ ] 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 - -## Screenshots (if applicable) - -Please add screenshots to help reviewers understand the changes. - -## Additional Notes - -Add any other notes or context about the pull request here. +### 自查清单 / Checklist +- [ ] 我已在本地测试过我的变更。 / I have tested my changes locally. +- [ ] 我已更新了必要的文档。 / I have updated the necessary documentation.