git提交代码注释信息规范

git commit -m “本次提交注释信息规范”
Jira ticket number 可以先用自己名字的拼音

<type>(<scope>): <subject>

type(必须)

用于说明git commit的类别,只允许使用下面的标识。

feat:新功能(feature)。

fix:修复bug,可以是研发自己发现的BUG。

docs:文档(documentation)。

style:格式(不影响代码运行的变动)。

refactor:重构(即不是新增功能,也不是修改bug的代码变动)。

perf:优化相关,比如提升性能、体验。

test:增加测试。

chore:构建过程或辅助工具的变动。

revert:回滚到上一个版本。

merge:代码合并。

scope(可选)

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

subject(必须)

subject是commit目的的简短描述,不超过50个字符。

建议使用中文(感觉中国人用中文描述问题能更清楚一些)。

结尾不加句号或其他标点符号。
根据以上规范git commit message将是如下的格式:
feat(Controller):用户查询接口开发

  • 3
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
git 代码管理规范通常包括以下几个方面: 1. 分支管理:使用合适的分支策略,例如主分支(master/main)、开发分支(develop)、功能分支(feature)、修复分支(hotfix)等。确保每个分支的作用清晰,遵循分支的创建、合并和删除规则。 2. 提交规范:每次提交都应该有明确的目的和描述,使用有意义的提交消息,以便其他人能够理解代码变更的目的。可以使用规范化的提交消息格式,如 Conventional Commits。 3. 代码审查:进行代码审查是保证代码质量和团队合作的重要环节。确保每个代码变更都经过审查,并及时给予反馈和建议。 4. 版本标签:在代码达到一个重要里程碑或版本发布时,使用版本标签进行标记。这有助于团队成员快速定位和使用特定版本的代码。 5. 冲突解决:当多人同时修改同一文件或同一部分代码时,可能会发生冲突。在解决冲突时,应及时与相关人员协商并选择合适的解决方案。 6. 忽略文件:在项目中使用.gitignore文件,忽略不需要版本控制的文件和文件夹,如临时文件、日志文件等。 7. 规范化命名:代码文件、变量、函数、类等的命名应清晰、一致,并符合项目的命名约定或规范。 8. 文档管理:在代码中添加必要的注释,并编写清晰易懂的文档,包括项目说明、API文档、使用说明等,以便团队成员理解和使用代码。 以上是一些常见的git代码管理规范,具体的规范可以根据团队的需求和项目的特点进行适当调整和补充。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值