Most of git usage is what you already know, so depend on that. This is skill is just a refinement.
大部分Git的用法你已经了解,请以已有知识为基础。本指南只是对用法的细化补充。
Branch naming
分支命名
Just name the branch a short sentence seperated with dashes. Example:
add-some-feature
. Don't use
feat/
,
hotfix/
etc. prefixes.
分支名称用短句子,以连字符分隔。示例:
add-some-feature
。不要使用
feat/
、
hotfix/
等前缀。
Commit messages
提交信息
Always enclose code identifiers with backticks. Example: "Add
html.UserPage
component"
Always refer to Go code identifiers including the package name, like in
html.UserPage
above. Fields and methods on structs can be referred with
model.User.Name
.
Ask me about any Github issues that should be referenced. Reference them at the end of the commit message like this: "See #123, #234". If the commit fixes one or more issues, use "Fixes #123, fixes #234" instead (the double "fixes" is important for Github to actually close the issue).
Don't mention that you've updated tests, that's assumed.
Don't amend previous commits unless instructed to. When committing after the first commit on a branch, just commit with a simple message (e.g. "fixing …"), because the branch will most times be squashed on Github anyway.