参与贡献
我们希望 DeepTutor 能成为送给社区的礼物。🎁
加入我们的社区
我们欢迎贡献!
无论您是修复 bug、改进文档还是添加新功能,您的贡献对我们都很有价值。
如何贡献
- 报告 Bug — 发现了 bug?在 GitHub 上开一个 issue,附上复现步骤
- 建议功能 — 在 GitHub Discussions 或我们的社区渠道分享想法
- 改进文档 — 帮助我们改进文档、教程和示例
- 提交代码 — 通过 Pull Request 修复 bug 或实现新功能
贡献指南
详细指南请参阅 CONTRIBUTING.md。
要点:
- 所有贡献必须基于
dev分支 - 提交前运行
pre-commit run --all-files - 使用约定式提交格式:
feat:、fix:、docs:等
快速入门
bash
# Fork 并克隆
git clone https://github.com/YOUR_USERNAME/DeepTutor.git
cd DeepTutor
# 从 dev 创建功能分支
git checkout dev && git pull origin dev
git checkout -b feature/your-feature-name
# 安装预提交钩子
pip install pre-commit && pre-commit install
# 进行更改,然后向 dev 分支提交 PR我们的贡献者
感谢您对 DeepTutor 贡献的兴趣!🚀
