参与贡献

感谢所有贡献者的支持！

如何贡献

1. Fork 项目

在 GitHub 上 Fork 本项目到你的账户。

2. 创建分支

git checkout -b feature/amazing-feature

3. 提交更改

git commit -m 'feat: Add some amazing feature'

4. 推送分支

git push origin feature/amazing-feature

5. 创建 PR

在 GitHub 上创建 Pull Request，详细描述你的更改内容。

开发指南

代码规范

• 遵循项目代码规范
• Python 代码使用 make format 格式化
• 使用 make lint 检查代码质量
• 添加必要的测试用例
• 更新相关文档

提交规范

使用清晰的提交信息：

feat: 添加新功能
fix: 修复 bug
docs: 更新文档
style: 代码格式调整
refactor: 代码重构
test: 添加测试
chore: 构建过程或辅助工具的变动

🐞 Bug 修复发布流程

如果在发布 v0.3.0 后发现 bug：

✅ 情况 1：main 上没有未完成的新功能

直接在 main 修复并发布：

git commit -m "fix: resolve config parser crash"
git tag -a v0.3.1 -m "Hotfix v0.3.1"
git push origin main --tags

⚙️ 情况 2：main 上已有新功能未完成

从上一个 tag 建立 hotfix 分支：

git checkout -b hotfix/0.3.1 v0.3.0
# 修复问题
git commit -m "fix: resolve config parser crash"
git push origin hotfix/0.3.1

# 测试后合并回 main 并打 tag
git checkout main
git merge --no-ff hotfix/0.3.1
git tag -a v0.3.1 -m "Hotfix v0.3.1"
git push origin main --tags

# 删除临时分支
git branch -d hotfix/0.3.1
git push origin --delete hotfix/0.3.1

测试要求

测试

• make lint / make format 保持代码整洁
• cp test/.env.test.example test/.env.test 配置测试凭据
• make router-tests 运行集成路由测试，支持 PYTEST_ARGS="-k chat_router"
• uv run --group test pytest test/api 可直接运行 pytest（容器内）

常用命令

# 全量路由测试
make router-tests

# 仅运行知识库相关用例
make router-tests PYTEST_ARGS="-k knowledge_router"

# 不经过 Makefile，直接调用 pytest
uv run --group test pytest test/api -vv

许可证

本项目基于 MIT License 开源，贡献的代码将遵循相同的许可证。