|
1 | 1 | --- |
2 | | - |
3 | | -title: Gitlens Code Suggest |
4 | | -description: Code Suggest in Gitlens |
| 2 | +title: GitLens Code Suggest |
| 3 | +description: Use GitLens Code Suggest to propose edits and code review suggestions across entire projects in GitHub repositories. |
5 | 4 | taxonomy: |
6 | 5 | category: gitlens |
7 | 6 |
|
8 | 7 | --- |
9 | 8 |
|
| 9 | +<kbd>Last updated: August 2025</kbd> |
10 | 10 |
|
11 | | -GitKraken Code Suggest simplifies code review by allowing you to make suggestions and edits across the entire project, not just on the lines that were changed, within GitLens, GitKraken Desktop, and gitkraken.dev. When a Pull Request is open, you can make suggestions to the pull request that others can then review and accept to include in the pull request. |
| 11 | +## What Is Code Suggest? |
12 | 12 |
|
13 | | -<div class='callout callout--basic'> |
14 | | - <p>Note: Code Suggest is currently only available for repositories on github.com.</p> |
15 | | -</div> |
| 13 | +**GitLens Code Suggest** simplifies code review by allowing you to make suggestions and edits across the entire project, not just on changed lines. |
| 14 | +Suggestions can be created within **GitLens**, **GitKraken Desktop**, or **gitkraken.dev** and attached to pull requests. |
16 | 15 |
|
17 | | -<imgsrc="/wp-content/uploads/gl-code-suggest.png"class="help-center-img img-bordered"> |
| 16 | +Reviewers can then view, accept, and apply these suggestions directly to the pull request branch. |
18 | 17 |
|
19 | | -To begin suggesting changes, open the [GitLens Inspect Overview](/gitlens/side-bar/#overview) for the desired repository and checkout a branch that has an open pull request. From here, you will have the option to _Start Review for PR #PR_. You may begin modifying and saving any file you would like to include in the code suggestion. Once you are ready, select _Suggest Changes for PR_, provide a title, and then finish with _Create Code Suggestion_. |
| 18 | +<figure> |
| 19 | + <img src="/wp-content/uploads/gl-code-suggest.png" class="help-center-img img-bordered" alt="GitLens Code Suggest view showing suggestion options" /> |
| 20 | + <figcaption style="text-align: center; color: #888">GitLens Code Suggest view</figcaption> |
| 21 | +</figure> |
20 | 22 |
|
21 | | -<imgsrc="/wp-content/uploads/gl-code-suggest-create.gif"class="help-center-img img-bordered"> |
| 23 | +--- |
22 | 24 |
|
23 | | -This will include a comment on the pull request with two options: you can select _Code Suggestion for #PR_ to open the suggestion in gitkraken.dev or select _locally on your machine_ to open the suggestion in GitKraken or GitLens. |
| 25 | +## Start a Code Suggestion |
24 | 26 |
|
25 | | -<img src="/wp-content/uploads/gl-code-suggest-comment.png" class="help-center-img img-bordered"> |
| 27 | +1. Open the [GitLens Inspect Overview](/gitlens/side-bar/#overview) for your repository. |
| 28 | +2. Check out a branch with an open pull request. |
| 29 | +3. Select **Start Review for PR #PR**. |
| 30 | +4. Modify and save any files you want to include in the suggestion. |
| 31 | +5. When ready, select **Suggest Changes for PR** → provide a title → **Create Code Suggestion**. |
26 | 32 |
|
27 | | -When selecting _locally on your machine_ you can open them on GitLens or [GitKraken Desktop](/gitkraken-client/pull-requests/#review-code-and-suggest-changes). Here, you can review the changes by selecting each file and once you are ready, you can select _Apply_ to apply to the branch you currently have checked out or select the dropdown and then _Apply to a Branch_ to apply to a new branch or select an existing branch. This will apply the patch locally. |
| 33 | +<figure> |
| 34 | + <img src="/wp-content/uploads/gl-code-suggest-create.gif" class="help-center-img img-bordered" alt="Creating a Code Suggestion in GitLens" /> |
| 35 | + <figcaption style="text-align: center; color: #888">Creating a Code Suggestion</figcaption> |
| 36 | +</figure> |
28 | 37 |
|
29 | | -<img src="/wp-content/uploads/gl-accept-code-suggestion-from-gl.gif" class="help-center-img img-bordered"> |
| 38 | +This action adds a comment on the pull request with two options: |
| 39 | +- **Code Suggestion for #PR** → review in **gitkraken.dev** |
| 40 | +- **Locally on your machine** → review in **GitLens** or **GitKraken Desktop** |
30 | 41 |
|
31 | | -When selecting the _Code Suggestion for #PR_ you will be taken to gitkraken.dev to review and accept the changes. Here, you can review the changes by selecting each file and once you are ready, you can select _Commit Suggestions_. This will create a new commit on the remote for the existing branch (shown under _COMMIT SUGGESTIONS TO_). |
| 42 | +<figure> |
| 43 | + <img src="/wp-content/uploads/gl-code-suggest-comment.png" class="help-center-img img-bordered" alt="Pull request comment with Code Suggestion options" /> |
| 44 | + <figcaption style="text-align: center; color: #888">Pull request with Code Suggestion comment</figcaption> |
| 45 | +</figure> |
| 46 | + |
| 47 | +--- |
32 | 48 |
|
33 | | -<img src="/wp-content/uploads/gl-accept-code-suggestion.gif" class="help-center-img img-bordered"> |
| 49 | +## Review and Apply Suggestions Locally |
| 50 | + |
| 51 | +1. Select **Locally on your machine**. |
| 52 | +2. Open the suggestion in GitLens or [GitKraken Desktop](/gitkraken-client/pull-requests/#review-code-and-suggest-changes). |
| 53 | +3. Review changes file by file. |
| 54 | +4. Choose **Apply** to apply to your current branch, or select **Apply to a Branch** to apply to a new or existing branch. |
| 55 | + |
| 56 | +<figure> |
| 57 | + <img src="/wp-content/uploads/gl-accept-code-suggestion-from-gl.gif" class="help-center-img img-bordered" alt="Applying a Code Suggestion locally in GitLens" /> |
| 58 | + <figcaption style="text-align: center; color: #888">Applying a Code Suggestion locally</figcaption> |
| 59 | +</figure> |
| 60 | + |
| 61 | +--- |
34 | 62 |
|
35 | | -*** |
| 63 | +## Review and Commit Suggestions in gitkraken.dev |
| 64 | + |
| 65 | +1. Select **Code Suggestion for #PR** to open the suggestion in **gitkraken.dev**. |
| 66 | +2. Review each file and its proposed changes. |
| 67 | +3. When ready, select **Commit Suggestions**. |
| 68 | + |
| 69 | +This creates a new commit on the remote branch (shown under **COMMIT SUGGESTIONS TO**). |
| 70 | + |
| 71 | +<figure> |
| 72 | + <img src="/wp-content/uploads/gl-accept-code-suggestion.gif" class="help-center-img img-bordered" alt="Accepting and committing Code Suggestions in gitkraken.dev" /> |
| 73 | + <figcaption style="text-align: center; color: #888">Committing suggestions in gitkraken.dev</figcaption> |
| 74 | +</figure> |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +## Availability |
| 79 | + |
| 80 | +<div class='callout callout--basic'> |
| 81 | + <p><strong>Note:</strong> Code Suggest is currently supported only for repositories on <strong>GitHub.com</strong>.</p> |
| 82 | +</div> |
0 commit comments