Git 工作流程礼仪

在上一篇文章中，我们讨论了开源生态系统中的分叉工作流程以及该工作流程如何帮助解决在为开源项目做贡献时可能出现的任何问题。但是除了工作流程中的这些步骤之外，重要的是您要遵循正确的提交消息、分支名称或 Pull Request 标题的命名约定，因此拥有这些正确的礼仪可以帮助您提高贡献并让其他维护者更容易评估你的工作。

分支的命名约定

您的分支名称语法可能类似于以下内容：

name/issue#/description

这里的名字可能是你的 Github Id 或者你的初始名字，issue 表示问题编号和关于分支的非常简短的描述

例子：

dora/45/new-feature

您还可以考虑以下命名约定：

A.如果是新功能

feature/name/issue#    

B.如果分支是为了修复新的错误

bug/name/issue#                

例子：

new-footer/dora/251

Git 提交消息的礼仪

拥有正确的提交消息有助于提高 git 日志和文件历史记录的可读性。可以考虑将您的提交消息命名为以下类别：

• 壮举——如果你致力于一项新功能
• 修复 -如果您的代码更改有助于修复一些错误
• docs –与文档相关的更改
• 样式 -与格式相关的更改
• 重构——如果更改仅与重构代码库有关
• test –如果添加新测试或修改旧测试
• chore –定期维护人员更改，例如，文档生成、版本控制、构建处理等

例子：

feat: New xyz component added

docs: Updated broken blog page link

您还可以通过提及文件的范围来制作更准确的提交消息：

type(scope): Message

在这里，type 包括上面讨论的各种类别，例如，feat、bug、docs 等
Scope – 表示代码更改的位置，例如，文件名

例子：

chore(netlify): Redirected old models

拉取请求指南

打开拉取请求时，请考虑在消息中添加以下几点

• 问题编号 - PR 可能关闭的问题
• 更改 -详细说明您所做的新更改
• 相关问题/公关 -链接所有相关问题和拉取请求

例子：

# Closes #412 

# Changes

- Change 1
- Change 2

# Related Issues:
- Issue #410
- PR #387

在这里， Closes #412 将向 Github 指示合并此 PR 将成功关闭编号为 412 的问题，并且可以将更改与项目符号一起列出以提高可读性。