Skip to content

贡献指南

感谢你对 AutoTable 的关注!我们欢迎任何形式的贡献。

贡献方式

🐛 报告 Bug

Gitee Issues 提交问题,请包含:

  • AutoTable 版本
  • 数据库类型和版本
  • 问题描述和复现步骤
  • 错误日志
  • 最小复现代码

💡 功能建议

同样在 Issues 中提交,说明:

  • 使用场景
  • 期望的行为
  • 可能的实现方式(可选)

📝 完善文档

文档位于 auto-table-doc 模块,欢迎:

  • 修复错误
  • 补充示例
  • 翻译文档
  • 分享使用经验(葵花宝典)

🔧 提交代码

  1. Fork 项目
  2. 创建特性分支:git checkout -b feature/your-feature
  3. 提交更改:git commit -m 'feat: add some feature'
  4. 推送分支:git push origin feature/your-feature
  5. 提交 Pull Request

开发环境

环境要求

  • JDK 1.8+
  • Maven 3.6+
  • Docker(可选,用于测试不同数据库)

本地构建

bash
git clone https://gitee.com/tangzc/auto-table.git
cd auto-table
mvn clean install -DskipTests

运行测试

bash
# 全部测试
mvn test

# 指定模块
mvn test -pl auto-table-test/auto-table-test-core

代码规范

提交信息

采用 Conventional Commits 规范:

feat: 新功能
fix: 修复 bug
docs: 文档更新
style: 代码格式
refactor: 重构
test: 测试相关
chore: 构建/工具

代码风格

  • 遵循项目现有代码风格
  • 添加必要的注释
  • 新功能需要配套测试

成为贡献者

提交的 PR 被合并后,你将成为 AutoTable 的贡献者。

联系方式

再次感谢你的贡献!🎉

Released under the Apache 2.0 License.