贡献指南

欢迎通过 Issue 和 Pull Request 改进 TradingCopilot。提交前应确保变更有清晰动机、可复现验证和必要文档。

本地检查

后端：

go test ./...
go vet ./...
go generate ./...
golangci-lint run

前端：

cd frontend
npm ci
npm run typegen:api
npm run build

文档站：

npm ci
npm run docs:build

API 变更

修改 API 时同步更新：

• api/openapi.yaml
• 生成的 Go 接口
• 生成的前端 TypeScript 类型
• API 契约文档
• 相关测试

数据库变更

修改持久化模型或迁移时同步更新：

• GORM 模型。
• 迁移逻辑。
• schema 初始化测试。
• 数据库契约文档。

文档规范

• 面向用户的页面先给可执行路径，再解释背景。
• 避免记录真实凭据、私有 URL 或内部账号。
• 命令示例同时考虑 Bash 和 PowerShell，必要时分别给出。
• 行为、配置和限制应与当前实现一致。