add CONTRIBUTING.md and PR template

This commit is contained in:
Monster
2025-07-11 15:19:02 +08:00
parent 7a56f86cd4
commit 8e29501130
2 changed files with 92 additions and 0 deletions

40
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,40 @@
# PR 标题
简要描述这次 PR 的目的和内容
## 相关 Issue
关闭或关联的 Issue (如有):
- 修复 #123
- 关联 #456
## 变更类型
请勾选适用的变更类型:
- [ ] Bug 修复 (不兼容变更的修复)
- [ ] 新功能 (不兼容变更的新功能)
- [ ] 功能改进 (不兼容现有功能的改进)
- [ ] 文档更新
- [ ] 依赖更新
- [ ] 重构 (不影响功能的代码修改)
- [ ] 测试用例
- [ ] CI/CD 配置变更
- [ ] 其他 (请描述):
## 变更内容
详细描述本次 PR 的具体变更内容:
1.
2.
3.
## 测试情况
描述本次变更的测试情况:
- [ ] 已本地测试
- [ ] 已添加测试用例
- [ ] 不需要测试 (理由: )
## 其他说明
任何其他需要说明的事项:

52
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,52 @@
# 贡献指南
欢迎为 PandaWiki 项目做贡献!本指南将帮助你开始贡献代码。
## 代码提交流程
1. 创建新的功能分支:
```bash
git checkout -b feat/your-feature-name
```
2. 提交代码前请确保:
- 已通过所有测试
- 已格式化代码
- 已更新相关文档
3. 创建 Pull Request:
- 确保 PR 有清晰的标题和描述
- 关联相关 Issue
- 遵循 PR 模板要求
## 代码风格
1. **Go 代码**:
- 使用 gofmt 格式化代码
- 遵循 effective go 指南
- 保持函数简洁 (<80 行)
2. **TypeScript 代码**:
- 使用 ESLint 检查代码
- 遵循标准 React 实践
- 使用 Prettier 格式化
## 测试要求
1. 后端:
- 所有主要功能应有单元测试
- 覆盖率不应低于 80%
- 运行 `make test` 来执行测试
2. 前端:
- 组件应包含基本测试
- 重要交互逻辑应有测试
- 运行 `npm test` 来执行测试
## 其他指南
- 提交消息应清晰且有意义
- 大功能实现应先创建设计文档
- 问题讨论可以在 GitHub Issues 中进行
- 遇到问题随时提问