... | ... | @@ -5,6 +5,7 @@ |
|
|
* Issues
|
|
|
* Epics
|
|
|
* 合并要求
|
|
|
* 代码片
|
|
|
* 提交
|
|
|
* diff
|
|
|
|
... | ... | @@ -149,3 +150,74 @@ |
|
|
您可以在评论中使用[快速操作](/docs/user/project/quick-actions) ,评论也将会显示提交评论后即将执行的操作。
|
|
|
|
|
|
要向评论添加更多评论,请照常开始写评论,然后单击**添加到评论**按钮,这会将评论添加到评论中。
|
|
|
|
|
|
## 建议更改
|
|
|
|
|
|
作为审阅者,您可以在合并请求的 diff 讨论中通过简单的 Markdown 语法来实现建议的代码修改。合并请求作者(或具有适当权限的其他用户)能够单击应用这些建议,同时将在合并请求中生成一个由接受并应用建议的用户产生的提交。
|
|
|
|
|
|
|
|
|
1. 找到你想要建议修改的代码,单击并添加一个新的评论,然后单击工具栏上的**插入建议**按钮:
|
|
|
|
|
|
[![](/docs/img/suggestion_button_v12_7.png)](/docs/img/suggestion_button_v12_7.png)
|
|
|
|
|
|
2. 在评论中,在预设好的代码块中添加上你的修改建议:
|
|
|
|
|
|
[![](/docs/img/make_suggestion_v12_7.png)](/docs/img/make_suggestion_v12_7.png)
|
|
|
|
|
|
3. 单击`启动评审`或`立即添加评论`按钮将你的修改建议添加到评论中。在合并请求中,你的修改建议可以直接被合并请求的作者直接应用:
|
|
|
|
|
|
[![](/docs/img/apply_suggestion_v12_7.png)](/docs/img/apply_suggestion_v12_7.png)
|
|
|
|
|
|
一旦作者接受了某个修改建议,它将会被标记为`已应用`,同时这个讨论也会被自动标记为`已解决`,系统也会将建议的修改直接提交给合并请求的源分支(注意:至少需要开发者权限才可以进行这个操作)。
|
|
|
|
|
|
### 多行的修改建议
|
|
|
|
|
|
通过调整修改范围,审阅者还可以在合并请求 diff 中通过一个建议对多行进行修改。这个修改范围的偏移相对于 diff 的位置,并指定应用建议时要替换的范围。
|
|
|
|
|
|
[![](/docs/img/multi-line-suggestion-syntax.png)](/docs/img/multi-line-suggestion-syntax.png)
|
|
|
|
|
|
在上面的例子中,建议修改的范围包括插入评论的上面四行和下面三行以。当该建议更改被接受后,以插入修改建议的 28 行为基准,会将其上方的四行和下方的三行按照建议的修改进行修改。
|
|
|
|
|
|
[![(/docs/img/multi-line-suggestion-preview.png)]](/docs/img/multi-line-suggestion-preview.png)
|
|
|
|
|
|
> 注意:合并请求 diff 中的多行修改建议限制在插入评论的上方100行和下方100行,即允许每个修改建议最多更改200行代码。
|
|
|
|
|
|
### 修改建议中的代码块
|
|
|
|
|
|
如果修改建议中包含代码块,则需要将包裹修改建议的3个反引号\`改为4个。
|
|
|
|
|
|
[![](/docs/img/suggestion_code_block_editor_v12_8.png)](/docs/img/suggestion_code_block_editor_v12_8.png)
|
|
|
|
|
|
[![](/docs/img/suggestion_code_block_output_v12_8.png)](/docs/img/suggestion_code_block_output_v12_8.png)
|
|
|
|
|
|
|
|
|
### 自定义修改建议的提交消息
|
|
|
|
|
|
在应用建议时使用默认的提交消息,其格式为:将 %{Suggestions_count}建议应用到 %{files_count}文件。例如,假设一个用户对2个不同的文件应用了3个建议,默认提交消息将是:对2个文件应用3个建议。
|
|
|
|
|
|
这些提交消息可以按照您的要求进行定制。如果需要定制,请在项目的常规设置中展开“合并请求”选项卡,然后更改“合并建议”文本:
|
|
|
|
|
|
除静态文本外,还支持使用以下变量:
|
|
|
|
|
|
| 变量 | 说明 | 输出示例 |
|
|
|
|--|--|--|
|
|
|
| %{branch_name} | 应用了建议的分支名称 | my-feature-branch|
|
|
|
| %{files_count} | 应用了建议的文件数量 | 2 |
|
|
|
| %{file_paths} | 应用了建议的文件路径,多个文件会用逗号分隔开| docs/index.md, docs/about.md |
|
|
|
| %{project_path} | 当前项目路径 | my-group/my-project |
|
|
|
| %{project_name} | 项目名称(可阅读) | 我的项目|
|
|
|
| %{suggestions_count} | 应用了的建议数量 | 3 |
|
|
|
| %{username} | 应用建议的用户id | lish |
|
|
|
| %{user_full_name} | 应用建议的用户昵称 | 李老师 |
|
|
|
|
|
|
比如,如果想要将提交信息定制为 “处理了李老师的代码审查”,可以将该提交信息设置为 '处理了 %{username} 的代码审查'
|
|
|
### 批量应用建议
|
|
|
|
|
|
You can apply multiple suggestions at once to reduce the number of commits added
|
|
|
to your branch to address your reviewers' requests.
|
|
|
|
|
|
你可以一次应用多个建议,以减少分支中按照你的代码审核人员建议修改后的提交次数。
|
|
|
|
|
|
可以通过单击“将建议加入批量处理”按钮来开启批量应用建议,多个建议被应用后只会产生一次提交。你可以按照你的需要多次添加修改建议;如果要从批量建议中移除某个建议,则单击“从批量中移除”按钮。当添加好全部需要应用的建议后,单击“应用建议(建议数量)”即可。
|
|
|
|
|
|
[![](/docs/img/apply_batch_of_suggestions_v13_1.png)](/docs/img/apply_batch_of_suggestions_v13_1.png) |
|
|
\ No newline at end of file |