贡献指南

感谢您对 tidoc 的兴趣！本文档说明如何参与贡献。

报告问题

请使用 GitHub Issue，按模板填写环境、复现步骤与期望结果。涉及发票识别问题时，如能附上去敏样例将极大帮助我们定位。

开发环境

环境搭建与启动、测试命令见 README 开发节。

提交改动

1. Fork 本仓库并创建分支。
2. 保持改动最小化，一个 PR 只做一件事。
3. 新增功能请补充测试；修复 bug 请补充回归测试。
4. 确保 pytest 通过。
5. 提交清晰的 commit message。
6. 发起 Pull Request 并填写模板。

代码风格

• 遵循 PEP 8。
• 使用类型注解。
• 后端 API 统一返回 {"ok": bool, ...}，异常不直接抛给前端。
• tidoc/adapters/、tidoc/web/adapter-ui.js 里有一批为紧凑而写的单行密集代码。不要为此整体重排（会淹没 git blame 并增加回归风险）；新增或修改到的函数请使用普通的多行写法：赋值和逗号后留空格，一行一个语句，一行不超过约 100 个字符。

发布

由维护者通过 GitHub Actions 触发，推送 tag v*.*.* 后自动打包并上传至腾讯云 COS。普通贡献者无需关心。