AWS amazonq documentation change
Summary
Added documentation for initiating code reviews using '/q review' slash command in GitHub pull requests, including step-by-step instructions and interaction details
Security assessment
The changes describe feature usage and workflow improvements for code reviews, with no mention of security vulnerabilities or security-specific enhancements. The additions focus on functionality rather than security controls.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/github-code-reviews.md b/amazonq/latest/qdeveloper-ug/github-code-reviews.md index a1edc8fa7..b74d6376d 100644 --- a//amazonq/latest/qdeveloper-ug/github-code-reviews.md +++ b//amazonq/latest/qdeveloper-ug/github-code-reviews.md @@ -4,0 +5,2 @@ +Initiating code reviews with Amazon Q Developer in GitHub pull requests + @@ -12,0 +15,2 @@ Amazon Q Developer enables automated code reviews within GitHub. When you create +You can also initiate code reviews within pull requests with the `/q review` slash command. The quick action can be added to a new pull request comment, which initiates a new code review of the pull request in its current state, including any comments and new commits. For more information, see Initiating code reviews with Amazon Q Developer in GitHub pull requests. + @@ -31,0 +36,25 @@ When you create a new pull request, Amazon Q Developer automatically begins a co + + + + +## Initiating code reviews with Amazon Q Developer in GitHub pull requests + +After an automatic code review performed by Amazon Q Developer for a new or reopened GitHub pull request, you can initiate additional code reviews to iterate on your code using the `/q review` slash command. The code review is performed on the entire pull request's diff. + +###### Note + +You can only initiate a code review within a pull request with a new comment. The `/q review` slash command will not work in an existing comment thread. + +###### To use initiate code reviews in a pull request + + 1. If necessary, sign in to your [GitHub](https://github.com/) account using your GitHub credentials. + + 2. Navigate to your GitHub organization, and then navigate to the pull request you want to perform a code review with Amazon Q Developer. For more information, see [About pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). + + 3. Within the pull request, navigate to **Add a comment** , and in the comment text input field, enter `/q review`. + + 4. Choose **Comment** to initiate the code review. + +It can take a few minutes for Amazon Q Developer to complete analyzing the pull request code. After Amazon Q Developer finishes analyzing, it replies to your comment with its critical and severity findings, as well as proposed changes you can choose to commit and update the pull request. + + 5. If you're satisfied with the suggested code fixes, you can merge the pull request to apply the code changes suggested by Amazon Q Developer. For more information, see [Merging a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request) in the _GitHub documentation_.