docs: github template
This commit is contained in:
tbphp
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,42 +1,34 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: 报告问题 (Bug Report)
|
||||||
about: Create a report to help us improve
|
about: 使用简练详细的语言描述你遇到的问题 (Describe the bug in detail)
|
||||||
title: "[BUG] "
|
title: ""
|
||||||
labels: "bug"
|
labels: bug
|
||||||
assignees: ""
|
assignees: ""
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
**例行检查 / Checklist**
|
||||||
A clear and concise description of what the bug is.
|
<!-- 方框内填 'x' / Put an 'x' in all the boxes that apply -->
|
||||||
|
- [ ] 我已确认目前没有类似 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 '...'
|
**问题描述 / Bug Description**
|
||||||
2. Click on '....'
|
<!-- 请清晰、简洁地描述问题。 / A clear and concise description of what the bug is. -->
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
**复现步骤 / Steps to Reproduce**
|
||||||
If applicable, add screenshots to help explain your problem.
|
<!-- 请提供复现问题的具体步骤。 / Steps to reproduce the behavior. -->
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
**Environment (please complete the following information):**
|
**预期结果 / Expected Behavior**
|
||||||
|
<!-- 请描述你预期的行为。 / A clear and concise description of what you expected to happen. -->
|
||||||
|
|
||||||
- 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**
|
**相关截图 / Screenshots**
|
||||||
Add any other context about the problem here.
|
<!-- 如果可以，请提供相关截图以帮助说明问题。 / If applicable, add screenshots to help explain your problem. -->
|
||||||
|
|
||||||
**Logs**
|
|
||||||
Please include any relevant logs:
|
|
||||||
|
|
||||||
```
|
|
||||||
paste logs here
|
|
||||||
```
|
|
||||||
|
|||||||
39
.github/ISSUE_TEMPLATE/feature_request.md
vendored
39
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,31 +1,24 @@
|
|||||||
---
|
---
|
||||||
name: Feature request
|
name: 功能请求 (Feature Request)
|
||||||
about: Suggest an idea for this project
|
about: 使用简练详细的语言描述希望加入的新功能 (Suggest an idea for this project)
|
||||||
title: "[FEATURE] "
|
title: ""
|
||||||
labels: "enhancement"
|
labels: enhancement
|
||||||
assignees: ""
|
assignees: ""
|
||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
**例行检查 / Checklist**
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
<!-- 方框内填 'x' / Put an 'x' in all the boxes that apply -->
|
||||||
|
- [ ] 我已确认目前没有类似 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**
|
**功能描述 / Feature Description**
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
<!-- 请清晰、简洁地描述你希望实现的功能。 / A clear and concise description of what you want to happen. -->
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context or screenshots about the feature request here.
|
|
||||||
|
|
||||||
**Implementation details (if applicable)**
|
**应用场景 / Use Case**
|
||||||
|
<!-- 请描述该功能可以解决什么问题或在什么场景下使用。 / Please describe what problem this feature would solve or in what scenarios it would be used. -->
|
||||||
- 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
|
|
||||||
|
|||||||
66
.github/pull_request_template.md
vendored
66
.github/pull_request_template.md
vendored
@@ -1,58 +1,16 @@
|
|||||||
---
|
### 关联 Issue / Related Issue
|
||||||
name: Pull Request
|
<!-- 请填写此 PR 关联的 issue 编号，例如：Closes #123 / Please link the issue number, e.g., Closes #123 -->
|
||||||
about: Submit a pull request to contribute to the project
|
Closes #
|
||||||
title: ""
|
|
||||||
labels: ""
|
|
||||||
assignees: ""
|
|
||||||
---
|
|
||||||
|
|
||||||
## Description
|
### 变更内容 / Change Content
|
||||||
|
<!-- 请简要描述本次变更的核心内容 / Please briefly describe the core changes of this PR -->
|
||||||
|
- [ ] Bug 修复 / Bug fix
|
||||||
|
- [ ] 新功能 / New feature
|
||||||
|
- [ ] 其他改动 / Other changes
|
||||||
|
|
||||||
Please include a summary of the change and which issue is fixed. Include relevant motivation and context.
|
<!-- 请在下方详细描述你的变更 / Please describe your changes in detail below -->
|
||||||
|
|
||||||
Fixes # (issue)
|
|
||||||
|
|
||||||
## Type of change
|
### 自查清单 / Checklist
|
||||||
|
- [ ] 我已在本地测试过我的变更。 / I have tested my changes locally.
|
||||||
Please select the relevant options:
|
- [ ] 我已更新了必要的文档。 / I have updated the necessary documentation.
|
||||||
|
|
||||||
- [ ] 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.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user