AWS amazonq medium security documentation change
Summary
Updated code review workflow to emphasize natural language input, added automated code issue remediation capabilities, and expanded guidance for addressing vulnerabilities.
Security assessment
Explicitly mentions detection of 'vulnerable code' and adds automated fix capabilities (wrench icon) for code issues. The ability to automatically remediate security vulnerabilities through IDE integration constitutes a security-related enhancement.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/start-review.md b/amazonq/latest/qdeveloper-ug/start-review.md index 7687f8594..09ae077ff 100644 --- a//amazonq/latest/qdeveloper-ug/start-review.md +++ b//amazonq/latest/qdeveloper-ug/start-review.md @@ -78 +78 @@ Visual Studio Code - 2. Choose the Amazon Q icon to open the chat panel. Enter `/review`. + 2. Choose the Amazon Q icon to open the chat panel. @@ -80 +80 @@ Visual Studio Code - 3. A new chat tab opens. Amazon Q prompts you to choose a project or file to review. If you’re reviewing a file, the file you want to review must be open and active in the IDE. If you’re reviewing a project, the project must be open in the IDE. + 3. Using natural language, describe the type of code review you want to run. You can review only your recent code changes, or an entire file. Code changes are determined based on the output of the git diff command on your file. @@ -82 +82 @@ Visual Studio Code - 4. Choose the type of review you want to run. Amazon Q begins reviewing the project or file that you currently have open in the IDE. +With your code project or file open in the IDE, you can enter things like: @@ -84 +84 @@ Visual Studio Code - 5. When the review is complete, the **Code Issues** tab opens above the chat panel with a list of the issues Amazon Q found. + * `Review my code changes` @@ -86 +86 @@ Visual Studio Code - 6. You can choose an issue to be redirected to the specific area of the file where the vulnerable or low-quality code was detected. + * `Run a code review on this file` @@ -88 +88 @@ Visual Studio Code -To see more details about the issue, choose the magnifying glass icon to the right of the code issue name in the **Code Issues** tab. A **Code Issue Details** panel opens on the right side of the IDE with information about the issue. + 4. Amazon Q will begin reviewing your file or project. Once complete, it will summarize the highest priority issues and observations. @@ -90 +90,11 @@ To see more details about the issue, choose the magnifying glass icon to the rig - 7. To address your code issues, see [Addressing code issues with Amazon Q Developer](./address-code-issues.html). +If any issues were detected, the **Code Issues** panel opens above the chat panel with a list of the issues Amazon Q found. + + 5. To learn more about a code issue, navigate to the **Code Issues** panel above the chat panel. From there, you can do the following: + + 1. Select an issue to be redirected to the specific area of the file where the vulnerable or low-quality code was detected. + + 2. To get an explanation of the code issue, choose the magnifying glass icon next to the name of the code issue. Amazon Q will provide details about the issue and suggest a remediation that you can insert into your code. + + 3. To fix the code issue, choose the wrench icon next to the name of the code issue. Amazon Q will provide a brief explanation of the fix and then make an in-place fix in your code file. You will see the code change in your file, and have the option to undo the change from the chat panel. + + 6. For more information about addressing code issues, see [Addressing code issues with Amazon Q Developer](./address-code-issues.html).