docs: github template
This commit is contained in:
66
.github/pull_request_template.md
vendored
66
.github/pull_request_template.md
vendored
@@ -1,58 +1,16 @@
|
||||
---
|
||||
name: Pull Request
|
||||
about: Submit a pull request to contribute to the project
|
||||
title: ""
|
||||
labels: ""
|
||||
assignees: ""
|
||||
---
|
||||
### 关联 Issue / Related Issue
|
||||
<!-- 请填写此 PR 关联的 issue 编号,例如:Closes #123 / Please link the issue number, e.g., Closes #123 -->
|
||||
Closes #
|
||||
|
||||
## 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
|
||||
|
||||
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.
|
||||
|
Reference in New Issue
Block a user