diff options
Diffstat (limited to 'doc/user/discussions')
| -rw-r--r-- | doc/user/discussions/img/insert_suggestion.png | bin | 0 -> 19913 bytes | |||
| -rw-r--r-- | doc/user/discussions/img/make_suggestion.png | bin | 0 -> 28447 bytes | |||
| -rw-r--r-- | doc/user/discussions/img/suggestion.png | bin | 0 -> 39775 bytes | |||
| -rw-r--r-- | doc/user/discussions/index.md | 45 |
4 files changed, 45 insertions, 0 deletions
diff --git a/doc/user/discussions/img/insert_suggestion.png b/doc/user/discussions/img/insert_suggestion.png Binary files differnew file mode 100644 index 00000000000..4bf293b8297 --- /dev/null +++ b/doc/user/discussions/img/insert_suggestion.png diff --git a/doc/user/discussions/img/make_suggestion.png b/doc/user/discussions/img/make_suggestion.png Binary files differnew file mode 100644 index 00000000000..20acc1417da --- /dev/null +++ b/doc/user/discussions/img/make_suggestion.png diff --git a/doc/user/discussions/img/suggestion.png b/doc/user/discussions/img/suggestion.png Binary files differnew file mode 100644 index 00000000000..68a67e6ae5e --- /dev/null +++ b/doc/user/discussions/img/suggestion.png diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index 0f89d261ff6..9379d047fca 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -293,6 +293,51 @@ Once you select one of the filters in a given issue or MR, GitLab will save your preference, so that it will persist when you visit the same page again from any device you're logged into. +## Suggest Changes + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/18008) in GitLab 11.6. + +As a reviewer, you're able to suggest code changes with a simple +markdown syntax in Merge Request Diff discussions. Then, the +Merge Request author (or other users with appropriate +[permission](../permissions.md)) is able to apply these +suggestions with a click, which will generate a commit in +the Merge Request authored by the user that applied them. + +1. Choose a line of code to be changed, add a new comment, then click +on the **Insert suggestion** icon in the toolbar: + +  + + > **Note:** + The suggestion will only affect the commented line. Multi-line + suggestions are currently not supported. Will be introduced by + [#53310](https://gitlab.com/gitlab-org/gitlab-ce/issues/53310). + +1. In the comment, add your suggestion to the pre-populated code block: + +  + +1. Click **Comment**. + + The suggestions in the comment can be applied by the merge request author + directly from the merge request: + +  + + > **Note:** + Discussions are _not_ automatically resolved. Will be introduced by + [#54405](https://gitlab.com/gitlab-org/gitlab-ce/issues/54405). + +Once the author applies a suggestion, it will be marked with the **Applied** label, +and GitLab will create a new commit with the message `Apply suggestion to <file-name>` +and push the suggested change directly into the codebase in the merge request's branch. +[Developer permission](../permissions.md) is required to do so. + +> **Note:** +Custom commit messages will be introduced by +[#54404](https://gitlab.com/gitlab-org/gitlab-ce/issues/54404). + [ce-5022]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5022 [ce-7125]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7125 [ce-7527]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7527 |
