贡献指南

欢迎通过 Issue、Discussion 或 Pull Request 参与 x-boot-cloud。

开发流程

Fork 并克隆仓库。
创建功能分支。
明确模块职责和调用链。
编写实现与回归测试。
更新相关文档和 SQL。
运行测试、构建和 Checkstyle。
提交 Conventional Commits 格式的变更。

代码约定

Java 21、UTF-8、4 空格缩进。
包名使用小写，类名使用 PascalCase，方法和字段使用 camelCase。
请求 DTO 以 DTO 结尾，响应模型使用 VO 或 BO。
Facade 接口用于跨模块契约，Controller 不直接依赖 Service 实现。
不提交密码、Token、API Key 或其他环境密钥。

验证命令

bash

# 全量构建与测试
mvn clean install

# 单模块测试
mvn -pl x-boot-modules/sys/sys-service -am test

# 代码规范
mvn checkstyle:check

提交信息

text

feat: add sys role export
fix: handle missing tenant context
test: cover cron parser
docs: update ai platform guide

Pull Request

PR 应说明：

修改了哪个模块和行为。
是否有配置、数据库或外部依赖影响。
运行过哪些测试和检查命令。
如果涉及 Controller 或文档，补充 API 示例或截图。