Skip to content

Contributing

李源炳 edited this page Sep 9, 2026 · 3 revisions

贡献指南

先了解项目

仓库分工

模块 仓库
Erlang 后端 imboy
Flutter 客户端 imboy-flutter
React 管理后台 imboy-admin-frontend,本地目录 imboyadmin/
数据库迁移库 erlang_migrate

提交流程

  1. 从目标仓库的 main 创建功能分支。
  2. 先读该仓库的 README、AGENTS.md/ CLAUDE.md 和相关文档。
  3. 修改代码、测试和受影响的契约/文档。
  4. 运行仓库要求的 lint、单元测试和边界检查。
  5. 使用 Conventional Commits,提交 Pull Request,并说明影响范围和验证结果。

重要约束

  • API 变更必须同步机器可读契约和客户端影响说明。
  • 不提交密钥、生产数据、真实 token、设备标识或个人信息。
  • 移动端 UI 变更先读 DESIGN.md,功能验证使用真机。
  • 安全漏洞不要公开提交,按 SECURITY.md 处理。

Clone this wiki locally