标签归档:git

github 发音

github 和git 发音都是get的音。今天刚学的。在英语里git是说讨厌的,需要get out的人。

Advertisements

【转帖】Commit message 编写指南

http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

这是ruanyifeng老师发表的博文内容,摘抄如下。

如果是博客文章类的commit,这个格式还不适用。

二、Commit message 的格式

每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。


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

其中,Header 是必需的,Body 和 Footer 可以省略。

不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。

2.1 Header

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

(1)type

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

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

如果typefeatfix,则该 commit 将肯定出现在 Change log 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 Change log,建议是不要。

(2)scope

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

(3)subject

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

  • 以动词开头,使用第一人称现在时,比如change,而不是changedchanges
  • 第一个字母小写
  • 结尾不加句号(.

2.2 Body

Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。


More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

有两个注意点。

(1)使用第一人称现在时,比如使用change而不是changedchanges

(2)应该说明代码变动的动机,以及与以前行为的对比。

2.3 Footer

Footer 部分只用于两种情况。

(1)不兼容变动

如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。


BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: 'attribute',
    }

    After:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

(2)关闭 Issue

如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。


Closes #234

也可以一次关闭多个 issue 。


Closes #123, #245, #992

2.4 Revert

还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。


revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的,必须写成This reverts commit &lt;hash>.,其中的hash是被撤销 commit 的 SHA 标识符。

如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,那么它们都不会出现在 Change log 里面。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts小标题下面。

使用Rstudio 连接 github 进行push/pull操作中常遇错误提示

我最后放弃了,这篇文章记录一下折腾的过程。Rstudio IDE 用gui界面无法成功push/pull,可以commit,所以最后还是在终端下才可执行push/pull

首先,第一个遇到的错误提示

error: unable to read askpass response from 'rpostback-askpass'
fatal: could not read Username for 'https://github.com': Device not configured

出现这个错误的原因是 repositories clone URL 为https://,也就是从github clone 到本地repositories 时 采用的命令时git clone https:// 这样的链接。

为了更正这个错误,一种方法是可以清除本地的repositories, 然后在github项目首页 右下方 clone 链接处 点击 ,You can clone with HTTPS,SSH, or Subversion, 复制clone 链接(新链接以git@github.com: 开头),重新clone。另一种方法,在本地repositories的 .git 文件夹下,找到config, 修改里面的https://链接,变成git@github.com:链接,注意git@github.com:链接的正确写法,git@github.com:用户名/项目名

在此之后,需要正确添加id_rsa,以及在github 添加SSH key,方法清自行google。

假设已经添加好,那么需要测试是否能用,

[root@localhost ~]# eval “$(ssh-agent -s)”
Agent pid 13881
[root@localhost ~]# ssh-add -l
The agent has no identities.
[root@localhost ~]# ssh-add
Enter passphrase for /root/.ssh/id_rsa:
Identity added: /root/.ssh/id_rsa (/root/.ssh/id_rsa)

[root@localhost ~]# ssh-add -l  #这次输入可以看到一串ssh key编号,说明正确添加成功

另外用[root@localhost ~]# ssh -vT git@github.com 可以查看从本地到github的传输情况,能看到下面这句话,说明已经可以正确通联github.com

Hi 你的github帐号! You’ve successfully authenticated, but GitHub does not provide shell access.

(参考 https://github.com/OHI-Science/ohicore/issues/104)

我卡在了第二个错误提示“public key不正确”上面,我可以通过终端用ssh 方法push,但就是在Rstudio IDE 的gui界面中无法实现。没有查到这方面的资料,问题尚未解决。依旧只能使用终端来push