Code Owners | GitCode 帮助文档

项目

代码

Code Owners

在GitCode网站上使用Code Owners功能可以帮助项目团队确保代码的关键部分由正确和合适的人员进行审查。Code Owners功能允许您为仓库中的特定文件或文件夹指定“所有者”。这些所有者会在相关文件或文件夹被修改并创建Pull Requests时自动被请求审查代码。本文将引导您如何在GitCode中设置和使用Code Owners功能，以提升代码审查的效率和质量。

创建CODEOWNERS文件

要启用Code Owners功能，首先需要在您的项目仓库中创建一个名为CODEOWNERS的文件。您可以将此文件放置在以下任一位置：

选择一个位置创建文件。GitCode会按照以下顺序检查这些位置：

CODEOWNERS 在仓库的根目录。
.gitcode/CODEOWNERS
docs/CODEOWNERS

如何创建CODEOWNERS文件

登录到您的GitCode账户并导航到相应的仓库。

进入仓库后，点击“新建文件”按钮。

将新文件命名为CODEOWNERS，并选择保存位置。

在文件编辑器中定义Code Owners规则（详见下方规则定义部分）。

提交新文件。

Code Owners规则示例

在CODEOWNERS文件中，您可以指定个人用户作为特定文件或路径的Code Owners。每个规则一行，支持使用#作为注释。下面是几个示例规则：

# 这是一个注释。
# 指定根目录下README文件的Code Owner
README.md @username

# 指定scripts文件夹的Code Owner
/scripts/ @username

# 指定所有JS文件的Code Owner
*.js @username

# 指定docs文件夹的多个Code Owners
/docs/ @username1 @username2

CODEOWNERS文件语法转义

警告：gitignore 文件有一些语法规则在 CODEOWNERS 文件中不起作用：

使用 \ 对以 # 开头的模式进行转义，将其视为模式而不是注释
使用 [ ] 定义字符范围,若你需要将某个部分设为可选，以便该部分中的代码审核的批准是可选的，那么在 [ ] 之前放置一个插入字符^即可。

下面是几个示例规则：

^[Scripts]
/scripts/ @username1 @username2

[Js]
*.js @username1 @username2

CODEOWNERS 文件使用遵循 gitignore 文件中所用的大多数相同规则的模式。模式后接一个或多个使用标准 @username 格式的 GitCode用户名。

如果要匹配两个或多个具有相同模式的代码所有者，所有的代码所有者必须位于同一行。如果代码所有者不在同一行，模式会仅匹配最后提到的代码所有者。假设您的CODEOWNERS文件中包含以下规则：

# 指定所有JS文件的Code Owners
*.js @frontendTeam

# 指定特定路径下所有文件的Code Owners
/src/scripts/ @javascriptExpert

# 项目根目录下的特定文件
/important.js @projectLead

如果有一个Pull Request修改了/src/scripts/important.js文件，那么仅最后一行的规则才会被匹配，本次修改也将指派给@projectLead进行审查。

CODEOWNERS文件说明

强烈建议通过Pull Requests来管理CODEOWNERS文件的更改，以便进行代码审查。
当项目中的代码发生变化，并且这些变化涉及到Code Owners负责的文件时，GitCode会根据CODEOWNERS文件中的规则自动请求Code Owners审查Pull Request。
如果有多个Code Owners，他们都会被添加到审查请求列表中。
CODEOWNERS 文件大小必须小于 3MB。当文件大小超过此限制时，GitCode将不会加载此 CODEOWNERS 文件。
CODEOWNERS 文件仅在PR所涉及的文件数量少于 1000 个时生效。

CODEOWNERS指派规则

当指派的用户不存于 GitCode，或不存在于项目的开发者以上角色，将不会指派对应用户，且不会提示。
CODEOWNER 同一文件的指派规则中的最后一行的规则才会生效。
CODEOWNER 指派的用户将不允许在页面上移除。 ‍

← 发行版