Git 提交要点
Git 提交规范、提交类型与示例,确保代码的可读性和可维护性。
Git 是一个非常强大的版本控制工具,允许跟踪和管理代码的更改。为了确保代码的可读性和可维护性,推荐使用一些提交规范。
提交规范
- 不超过 50 个字符的提交标题
- 每行不超过 72 个字符
- 不要在没有更改的情况下提交
- 不要提交未测试的代码
- 不要提交未合并的代码
- 不要提交未完成的更改
- 尽可能早地合并你的更改
- 不要忘记添加必要的关联信息
- 避免在同一个提交中包含多项逻辑更改
- 确保你的代码可以被其他人成功地运行
提交类型
1feat:新增功能(feature)
2fix:修复 Bug
3docs:文档相关变动
4style:代码格式、样式调整
5refactor:重构代码,没有新功能和修复 bug
6perf:优化相关,比如提升性能、体验
7test:添加或修改测试代码
8build:影响构建系统或外部依赖项的更改
9chore:构建过程或辅助工具的变动
示例提交消息:
1feat: 添加用户注册功能
2fix: 修复登录界面显示错误的问题
3docs: 更新 README 文件
4style: 格式化代码缩进
5refactor: 重构数据处理逻辑
6perf: 优化内存
7test: 添加用户登录测试用例
8build: gradle 增加 fastjson 依赖
9chore: 更新构建脚本
评论
src/consts.ts中GISCUS的enabled设为true并填入 repo / repoId / categoryId。