贡献指南
我们非常欢迎社区的贡献!无论是 bug 修复、新功能开发、文档完善还是问题反馈,都是对项目的宝贵支持。
Git 提交规范
为了保持项目历史的清晰和一致性,请遵循以下提交信息格式:
基本格式
text
type(scope): subject
body
footer各部分详细说明
- type: 提交类型(必填)
- scope: 影响范围(可选)- 如 web, api, auth 等,用括号包围
- subject: 简短描述(必填)- 一句话说明本次提交做了什么
- body: 详细描述(可选)- 详细说明为什么做这个改动,如何实现的
- footer: 脚注信息(可选)- 如关闭的 issue 编号、破坏性变更说明等
Type 类型说明
| 类型 | 说明 |
|---|---|
feat | 新功能 (feature) |
fix | 修复 bug |
docs | 文档更新 |
style | 代码格式调整(不影响功能,如空格、分号等) |
refactor | 代码重构(即不是新增功能,也不是修改 bug 的代码变动) |
test | 测试相关 |
chore | 构建过程或辅助工具的变动 |
perf | 性能优化 |
ci | CI/CD 相关 |
Scope 范围示例
| 范围 | 说明 |
|---|---|
web | 前端相关 |
api | 后端 API 相关 |
node | 任务节点相关 |
auth | 认证相关 |
i18n | 国际化相关 |
log | 日志相关 |
db | 数据库相关 |
实际示例
示例 1:添加新功能
text
feat(auth): 添加双因素认证功能
为了提高系统安全性,实现了基于TOTP的双因素认证:
- 支持Google Authenticator等认证应用
- 提供二维码和手动输入两种设置方式
- 完整的启用/禁用流程
Closes #123示例 2:修复 Bug
bash
fix(web): 修复任务列表分页显示问题示例 3:文档更新
bash
docs(readme): 更新安装说明文档如何参与
- Fork 项目 - 点击 GitHub 仓库右上角的 Fork 按钮
- 创建分支 -
git checkout -b feature/your-feature - 提交代码 - 遵循上述提交规范
- 推送分支 -
git push origin feature/your-feature - 创建 PR - 在 GitHub 上创建 Pull Request
开发建议
- 提交前请运行
make test确保测试通过 - 新功能请添加相应的测试用例
- 重要功能请更新相关文档
- 保持代码风格一致
- 提交信息请使用中文或英文,保持简洁明了
我们期待您的参与,让 gocron 变得更加完善!🚀