Skip to content

贡献指南

欢迎贡献!以下是开发流程。

开发环境

bash
git clone https://github.com/gocronx/gocronx-scaffold.git
cd gocronx-scaffold
go mod tidy
go build ./cmd/gocronx/

运行测试

bash
go test ./...

项目结构

  • cmd/gocronx/ — CLI 工具入口
  • internal/cli/ — CLI 命令(init、update、uninstall)
  • internal/generator/ — 模板引擎和嵌入模板
  • internal/generator/templates/ — 所有项目模板文件

添加新模板文件

  1. internal/generator/templates/ 下添加文件
  2. 如果需要变量替换,使用 [[ .Variable ]] 语法并以 .tmpl 为扩展名
  3. 静态文件(无需替换)保持原始扩展名
  4. 运行测试:go test ./internal/generator/

提交规范

使用 Conventional Commits:

feat: 添加 Redis 集群支持
fix: 修复 Windows 下模板路径问题
docs: 更新 CLI 参考文档