贡献指南
感谢你为 Spectra 提交代码、文档、问题反馈或改进建议。本页说明一次贡献需要具备的上下文、验证证据和提交边界。
先确定修改范围
- 后端 Java、Controller、Service、持久化、事务、安全或模块边界：阅读 后端文档 及对应领域说明。
- Web Vue、TypeScript、路由、组件、Pinia、请求和测试：阅读 前端总览 及对应页面说明。
- BPMN 插件、节点、Schema、导入导出和宿主集成：阅读 流程设计器总览。
- 环境、构建、测试、部署或文档同步：阅读 开发指南 和 部署运维。
修改代码前先确认是否会影响接口、配置、数据库、权限、部署或文档事实；受影响的文档必须与代码同一变更提交。
本地准备
- 使用递归方式克隆根仓库并初始化子模块。
- 在每个子项目审查
mise.toml后安装对应工具链。 - 从
.example创建本机配置；密码、Token、证书和安全主密钥只保存于 Git 忽略文件或部署 Secret。 - 根据修改范围安装后端、Web 或插件依赖。
- 先运行目标模块的快速检查，再运行完整质量门禁。
完整命令见 常见命令。
修改要求
- 保持 API 契约版本
1.0.0，修改接口时同步请求方、接口总览和使用说明。 - 新增或删除 Entity、Controller、配置项、环境变量或 Flyway migration 时，更新对应参考文档。
- 前端菜单和按钮变更时，同时检查后端 Permission、菜单数据和使用指南。
- 文档使用中文标题和稳定路径，不使用任务编号、整改过程或计划性表述。
- 示例可以使用占位符，但不能包含真实密码、Token、密钥、私钥、Cookie 或生产地址。
- 不提交构建产物、
.mise.local.toml、.env*本机覆盖、证书文件和临时缓存。
验证清单
根据修改范围执行必要检查，并在合并请求中说明结果：
bash
./scripts/check-docs.sh
(cd spectra-admin && mise exec -- ./mvnw spotless:check && mise exec -- ./mvnw test)
(cd spectra-ui && mise exec -- pnpm run format:check && mise exec -- pnpm run lint \
&& mise exec -- pnpm run type-check && mise exec -- pnpm run test && mise exec -- pnpm run build)
(cd logicflow-plugin-flowable && mise exec -- pnpm run format:check && mise exec -- pnpm run build)不相关的完整检查可以省略，但必须在合并请求中说明省略原因。文档同步还需要执行网站 Preview 和 VitePress 构建。
提交前自查
- 文档链接可以从源仓库和网站页面访问。
- 页面标题、侧边栏标题和目录名称没有中英混杂或旧路径。
- 使用指南只描述当前页面和接口已经提供的能力。
- 生成的网站页面不包含
AI速查、本机配置和博客文件。 git diff --check没有空白错误，差异中没有凭据或无关文件。