贡献指南
感谢你对项目的关注!本页介绍如何参与项目开发。
贡献方式
- 🐛 报告 Bug
- 💡 提出新功能建议
- 📝 改进文档
- 🔧 提交代码
报告 Bug
- 在 Issues 搜索是否已有相同问题
- 如果没有,创建新 Issue
- 使用 Bug 报告模板
- 提供详细的复现步骤
提交代码
1. Fork 项目
点击 GitHub 页面右上角的 Fork 按钮。
2. 克隆到本地
bash
git clone https://github.com/你的用户名/wenyanwengongju.git
cd wenyanwengongju3. 创建分支
bash
git checkout -b feature/你的功能名4. 开发
bash
npm install
npm run dev5. 测试
bash
npm test确保所有测试通过。
6. 提交
bash
git add .
git commit -m "feat: 你的功能描述"遵循 提交规范。
7. 推送
bash
git push origin feature/你的功能名8. 创建 Pull Request
在 GitHub 上创建 PR,描述你的改动。
提交规范
使用约定式提交格式:
<type>: <description>Type 类型
| Type | 说明 |
|---|---|
| feat | 新功能 |
| fix | Bug 修复 |
| docs | 文档更新 |
| style | 代码格式(不影响功能) |
| refactor | 重构 |
| test | 测试相关 |
| chore | 构建/工具 |
示例
feat: 添加批量导入功能
fix: 修复搜索结果分页问题
docs: 更新 API 文档代码规范
- 使用 TypeScript
- 遵循 ESLint 规则
- 使用 Prettier 格式化
- 编写单元测试
开发流程
- 从
main分支创建功能分支 - 在功能分支上开发
- 提交 PR 到
main - 代码审查通过后合并
需要帮助?
- 查看 技术文档
- 在 Issues 中提问
- 查看已有的 PR 作为参考