git提交注释规范

这篇具有很好参考价值的文章主要介绍了git提交注释规范。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

git初始化

首先下载安装git,配置好公私密钥和github

git命令

git init
git remote add origin [远程库地址]
git pull origin master
git add .
git commit -m “注释”
git push origin master

其他:
git status
git log
git branch
git checkout
git merge

git 注释 格式:

<type>(<scope>): <subject>
// 空一行
<body>

type(必需)

用于说明 commit 的类别

br: 此项特别针对bug号,用于向测试反馈bug列表的bug修改情况
feat:新功能(feature)
fix:修补
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:其他的小改动. 一般为仅仅一两行的改动, 或者连续几次提交的小改动属于这种
revert:feat(pencil): add ‘graphiteWidth’ option (撤销之前的commit)
upgrade:升级改造
bugfix:修补bug
optimize:优化
perf: Performance的缩写, 提升代码性能
test:新增测试用例或是更新现有测试
ci:主要目的是修改项目继续完成集成流程(例如Travis,Jenkins,GitLab CI,Circle)的提交
build: 主要目的是修改项目构建系统(例如glup,webpack,rollup的配置等)的提交

scope(可选)

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

subject(必需)

subject是 commit 目的的简短描述,不超过50个字符。
以动词开头,使用第一人称现在时,比如change,而不是changed或changes
第一个字母小写
结尾不加句号(.)

(可选)部分

是对本次 commit 的详细描述,可以分成多行文章来源地址https://www.toymoban.com/news/detail-820896.html

到了这里,关于git提交注释规范的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Git提交规范指南

    在开发过程中,Git每次提交代码,都需要写Commit message(提交说明),规范的Commit message有很多好处: 方便快速浏览查找,回溯之前的工作内容 可以直接从commit 生成Change log(发布时用于说明版本差异) 为了方便使用,我们避免了过于复杂的规定,格式较为简单且不限制中英文

    2024年02月12日
    浏览(24)
  • git提交规范

    在团队协作中,Git 提交规范对于代码的可维护性和版本管理非常重要。下面总结了一些常见的提交规范: 每个 Git 提交信息都应该包含一个清晰简洁的标题和一个更详细的描述。推荐的提交信息格式如下: 其中, type 代表提交类型, scope 代表影响范围, subject 是提交信息的

    2024年02月05日
    浏览(65)
  • Git 提交前缀规范

    feat : 新功能。添加一个新的用户界面元素、一个新的功能或一个新的 API fix : 修复 bug。修复一个导致应用程序崩溃的错误、一个导致数据丢失的错误或一个导致用户体验不佳的错误 docs : 文档更新。更新你的应用程序的用户指南、更新你的 API 文档或更新你的技术文档 style

    2024年01月19日
    浏览(38)
  • Git 提交规范

    在项目中采用 git 管理代码版本时,突然不能进行提交(git commit)。 报错信息如下: ERROR invalid commit message format. Proper commit message format is required for automated changelog generation. 合法的提交日志格式如下(emoji 和 模块可选填): 💥 feat(模块): 添加了个很棒的功能 🐛 fix(模块): 修复

    2024年01月19日
    浏览(30)
  • Git 提交描述规范

    在Git提交消息中,可以使用特定字符来表示特定的功能,这些字符的使用可以提高提交描述的可读性和易用性,常见的字符如下: fix :表示该提交用于修复错误或问题。 feat :表示该提交用于添加新功能。 docs :表示该提交用于更新文档。 style :表示该提交用于代码格式化

    2024年02月16日
    浏览(27)
  • 前端项目git提交规范配置

    为了使团队多人协作更加的规范,所以需要每次在 git 提交的时候,做一次硬性规范提交,规范 git 的提交信息 安装依赖 配置package.json 新增配置文件 commitlint.config.js 添加自定义提示 .cz-config.cjs 安装 创建 .prettierrc 文件,并添加如下配置, 具体配置可以查看官网 安装(注意:这

    2024年02月19日
    浏览(32)
  • 【Git】提交规范:格式,类型,范围

    学习一下git提交规范 类型,范围 标题行: 必填, 描述主要修改类型和内容 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等 页脚注释: 放 Breaking Changes 或 Closed Issues feat: 新功能、新特性(feature) fix: 修补bug perf: 更改代码,以提高性能(在不影响代码内部行

    2024年01月22日
    浏览(30)
  • vue项目配置git提交规范

    项目中代码格式以及git message如果不加以约束,可能最终的格式会五花八门,这样很不利于我们的项目合作。所以我们需要使用工具来约束提交代码和信息的格式。 Husky 是一个 Git Hook 工具,可以帮助我们在 Git 事件发生时自动运行脚本。Git Hook 是一种机制,它允许在 Git 执行

    2024年02月11日
    浏览(38)
  • Git 修改已提交的commit注释

    已经将代码push到远程仓库 还没将代码push到远程仓库,还在本地的仓库中 这两种情况下的修改大体相同,只是第一种情况最后会多一步后面会做介绍。 先搞清楚你要修改哪次的提交注释或者哪几次的提交注释 2.1 修改最后一次注释 如果你只想修改最后一次注释(就是最新的

    2024年02月01日
    浏览(34)
  • 设置webstorm和idea符合Alibaba规范 git提交规范

    插件建议 Alibaba Java Coding Guidelines (新版本的idea不支持,有其他同名的非官方版可代替),使用方法在此不赘述。安装好后找到对应的设置打开要提醒的规则 提供两种方法,推荐第一种,安装阿里规约的方式,如果你的同事已经初始化好了项目配置,直接跳到 f2elint 使用 开

    2024年02月05日
    浏览(33)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包