掌握编写有效的GitHub提交信息的艺术

更新日期: 2023-02-02阅读: 784标签: github

写提交信息没有严格的规则,但当在GitHub上做项目时,清楚、简洁地传达你所做的修改是很重要的。做到这一点的方法之一是在提交信息中使用关键字。

这些关键词,或标签,有助于表明变化的性质,使其他人更容易理解你的贡献的背景。

以下是一些常见的关键词和它们所表示的内容。

FEAT:使用这个关键词来表示你正在致力于一项新的功能。

"FEAT: Add new login functionality."

FIX:使用这个关键词表示你正在对一个特定的问题或议题进行修复。

"FIX: Fix bug causing crashes on certain devices."

STYLE: 使用这个关键词表示你正在对代码的风格或格式进行修改,而不是对其功能进行修改。

"STYLE: Update indentation in main.js."

REFACTOR: 使用这个关键词表示你正在对代码进行修改,改善其结构或组织,但不增加新的功能或修复错误。

"REFACTOR: Refactor the code to improve readability."

TEST: 使用这个关键字表示你正在为代码添加或更新测试。

"TEST: Add new unit tests for login functionality."

CHORE:使用这个关键词表示你正在对构建过程或其他与代码本身没有直接关系的任务进行修改。

"CHORE: Update dependencies in package.json."

PERF:使用这个关键词表示你正在进行修改以提高代码的性能。

"PERF: Optimize image loading for faster performance."

CI:使用这个关键词表示你正在对持续集成过程进行修改。

"CI: Fix issue with test pipeline on Dashboard CI."

BUILD:使用这个关键词表示你正在对构建过程进行修改。

"BUILD: Add new script for building the production version of the app."

通过在你的提交信息中使用这些关键词,可以帮助使你的贡献更清晰,更容易被他人理解。然而,需要注意的是,这些只是建议,并不是所有的项目都使用这些建议,如果团队有自己的规范,那么应该按自己的规范走。

来源: 大迁世界


链接: https://www.fly63.com/article/detial/12348

远程协作尝试,Github远程协作

远程协作是一个听起来很酷的词,就像谈恋爱一样,听起来总是觉得它和浪漫一词相关。远程协作好处可以想象:节省办公室租金,工作环境自由/高效/免打扰,节省路途时间,更有可能招到更好的人才....

Gitment - 一款基于Github的Issues实现的评论插件

发现一个有意思的评论插件Gitment, 基本原理是利用Github项目上的Issues功能来实现内容的存储,使用github的账号登录体系。和自己的博客集成起来也比较简单,一个css文件,一个js文件,一段初始化代码就可以了。

GitHub 多账户设置

由于不同的 GitHub 不能使用同一个 SSH 公钥,所以要生成两个不同的 SSH 分别对应两个主账户和副账户。编辑 ~/.ssh/config SSH 配置文件,没有该文件则新建。然后,以后使用 main 账户添加远程仓库需要这样添加,部署相应的 SSH 公钥到 GitHub 后,尝试在相应的本地仓库 git push 几个文件测试。

官宣:Github 正式加入微软

GitHub是科技业界最流行的代码托管平台,微软于2018-6月宣布收购 GitHub,微软不会通过市场力量来破坏 GitHub 的开放性,在2018-10月Github 正式宣布加入了微软大家庭

GitHub发布史上最大更新,年度报告出炉!

在昨天的 GitHub Universe 开发者大会上,GitHub 发布了史上最大更新:可直接运行部分代码的 GitHub Actions,以及宣布了 2018 年的 GitHub 年度报告,包括最热门的开源项目和编程语言,让我们一起来先睹为快!

Github上写Blog

预备知识:必须:Git,GitHub,Jekyll,Markdown,YAML,操作:注册一个GitHub的账号,可以使用GitHub Desktop或者GitHub网站;创建一个空的项目,在项目里面创建index.md,或者index.html,提交后,博客首页就建好了。

GitHub上传文件不能超过100M的解决办法

上传项目到GitHub上,当某个文件大小超过100M时,就会上传失败,因为默认的限制了上传文件大小不能超过100M。如果需要上传超过100M的文件,就需要我们自己去修改配置。

拒绝重复造轮子!GitHub推出新功能repository templates

GitHub 新功能 repository templates 帮助开发者在所有项目中重用代码。在不同代码库中共享样板代码(boilerplate code)是软件开发的惯例。使用喜欢的工具和目录结构开启新项目,能够帮助程序员更加高效地完成从想法到程序的转变

Github 上十个优秀的 Repo

以下是 Github 上十个优秀的 Repo ,可以用它们在短时间内增加个人的知识储备。毫无疑问,Awesome是最受欢迎的库,它涵盖了从软件开发到硬件再到业务的所有主题。 目前,它在Github上拿到超123,000星,且其内容庞大

GitHub:除非真正需要,否则我们不会删除您的任何内容

不仅仅是社交媒体巨头在努力的让用户相信平台的透明度,微软旗下的 GitHub,也在致力于此。作为一个代码共享平台兼作开发人员的社区

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!