mirror of
https://github.com/rustfs/console.git
synced 2026-11-01 21:22:41 +08:00
overtrue
9001300b96
- Add requirement that all commit messages must be in English - Update README.md with examples of correct/incorrect commit messages - Update .github/README.md with commit message guidelines - Add commit message check to PR template
155 lines
3.4 KiB
Markdown
155 lines
3.4 KiB
Markdown
# 📝 Pull Request
|
|
|
|
## 📋 Description
|
|
|
|
<!-- 请简要描述这个 PR 的目的和内容 -->
|
|
|
|
## 🔄 Type of Change
|
|
|
|
<!-- 请选择适用的选项 -->
|
|
|
|
- [ ] 🐛 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)
|
|
- [ ] 📚 Documentation update
|
|
- [ ] 🔧 Code refactoring
|
|
- [ ] ⚡ Performance improvement
|
|
- [ ] 🧪 Test improvements
|
|
- [ ] 🔒 Security fix
|
|
|
|
## 🧪 Testing
|
|
|
|
<!-- 请描述你如何测试了这些更改 -->
|
|
|
|
### Test Coverage
|
|
|
|
- [ ] Unit tests added/updated
|
|
- [ ] Integration tests added/updated
|
|
- [ ] Performance tests added/updated
|
|
- [ ] Manual testing completed
|
|
|
|
### Test Results
|
|
<!-- 粘贴测试结果或截图 -->
|
|
|
|
```bash
|
|
# 运行测试的命令和结果
|
|
npm run test
|
|
```
|
|
|
|
## 📊 Performance Impact
|
|
|
|
<!-- 如果适用，请描述性能影响 -->
|
|
|
|
- [ ] No performance impact
|
|
- [ ] Performance improved
|
|
- [ ] Performance impact analyzed and acceptable
|
|
- [ ] Performance benchmarks included
|
|
|
|
## 🔒 Security Considerations
|
|
|
|
<!-- 如果适用，请描述安全考虑 -->
|
|
|
|
- [ ] No security impact
|
|
- [ ] Security review completed
|
|
- [ ] Vulnerability assessment done
|
|
- [ ] Security tests added
|
|
|
|
## 📚 Documentation
|
|
|
|
<!-- 请确认文档更新 -->
|
|
|
|
- [ ] Code comments updated
|
|
- [ ] README updated (if needed)
|
|
- [ ] API documentation updated (if needed)
|
|
- [ ] Changelog updated
|
|
|
|
## ✅ Checklist
|
|
|
|
<!-- 请确认以下项目 -->
|
|
|
|
### Code Quality
|
|
|
|
- [ ] Code follows the project's style guidelines
|
|
- [ ] Self-review of the code completed
|
|
- [ ] Code is properly commented
|
|
- [ ] No console.log or debug statements left
|
|
- [ ] TypeScript types are properly defined
|
|
- [ ] All commit messages are in English (following Conventional Commits)
|
|
|
|
### Testing
|
|
|
|
- [ ] All existing tests pass
|
|
- [ ] New tests cover the changes
|
|
- [ ] Test coverage is maintained or improved
|
|
- [ ] Edge cases are tested
|
|
|
|
### Dependencies
|
|
|
|
- [ ] No new dependencies added, or they are justified
|
|
- [ ] Dependencies are up to date
|
|
- [ ] No security vulnerabilities in dependencies
|
|
|
|
### Compatibility
|
|
|
|
- [ ] Changes are backward compatible
|
|
- [ ] Browser compatibility maintained
|
|
- [ ] Node.js version compatibility maintained
|
|
|
|
## 🔗 Related Issues
|
|
|
|
<!-- 链接相关的 issues -->
|
|
|
|
Closes #<!-- issue number -->
|
|
Fixes #<!-- issue number -->
|
|
Related to #<!-- issue number -->
|
|
|
|
## 📸 Screenshots (if applicable)
|
|
|
|
<!-- 如果有 UI 更改，请添加截图 -->
|
|
|
|
| Before | After |
|
|
|--------|-------|
|
|
| <!-- screenshot --> | <!-- screenshot --> |
|
|
|
|
## 🚀 Deployment Notes
|
|
|
|
<!-- 部署时需要注意的事项 -->
|
|
|
|
- [ ] No special deployment steps required
|
|
- [ ] Database migration required
|
|
- [ ] Configuration changes required
|
|
- [ ] Environment variables updated
|
|
|
|
## 👥 Reviewers
|
|
|
|
<!-- @mention 需要 review 的人员 -->
|
|
|
|
Please review: @<!-- username -->
|
|
|
|
## 📝 Additional Notes
|
|
|
|
<!-- 任何其他需要说明的内容 -->
|
|
|
|
---
|
|
|
|
### 🤖 Automated Checks
|
|
|
|
The following checks will be automatically performed:
|
|
|
|
- ✅ Code formatting (Prettier)
|
|
- ✅ Type checking (TypeScript)
|
|
- ✅ Linting (ESLint)
|
|
- ✅ Unit tests
|
|
- ✅ Integration tests
|
|
- ✅ Security scan
|
|
- ✅ Performance tests
|
|
- ✅ Build verification
|
|
|
|
### 📊 Code Coverage
|
|
|
|
Current coverage will be displayed here after the tests run.
|
|
|
|
### ⚡ Performance Benchmarks
|
|
|
|
Performance impact will be analyzed and displayed here.
|