github-learning-lab[bot]
commented
2 years ago Reviewing Pull Requests
Nice work @ai5. By providing feedback, you've enabled me to reevaluate how I am making my desired change. But, pull request reviews don't stop at commenting. You can also approve or request changes on my pull request.
When you get asked to review something, you should acknowledge the request. Acknowledging a review request could take several forms. It could be leaving a comment on the pull request or leaving a review. In some cases, it could be rejecting the review request altogether.
Before you review, some things to consider
#### Discern the context Review the title and body of the pull request to understand the intended change. This should help you identify limitations, boundaries, and other important context. #### Observing the progress As a reviewer, there are certain things to look for when identifying how to best provide feedback. In early stages, reviews should focus on the general direction of the changes. Identify if the goal is possible, rather than nitpicking the style, polish, or wording. Pull requests that are closer to merging should receive a robust review. Thorough testing is one of many ways to ensure the changes won't break the project. Regardless of timing, focus your feedback on the most essential changes. Suggest changes for minor issues within the pull request. When suggesting major changes, open a separate pull request against the author's branch.Step 3: Leave a review
I've made some changes to this branch and would love :heart: it if you could approve this pull request. For now, just approving the pull request will suffice. In a moment we will look at requesting changes. :+1:
:keyboard: Activity: Approve a pull request
- In the pull request, click the Files changed tab
- Review the changes in the pull request by commenting on specific lines
- Above the changed code, click Review changes
- Type a comment summarizing your feedback on the proposed changes
- Select Approve to approve merging the changes proposed in the pull request
- Click Submit review
Return to this pull request for my next comment
Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response, wait a few seconds and refresh the page for your next steps.
Commenting on Pull Requests
As a collaborator on a repository, you will get and give pull request reviews before merging code. This is important! It ensures quality code and maintains momentum of changes to your project.
As you can see, I've opened this pull request and requested you as a reviewer. Pull requests are places to share the changes made to the repository.
Responsibilities of a reviewer
As a pull request reviewer, your role is to help the pull request author (thats me!) by making sure:
These broad responsibilities can include more specific goals, like:
Some repositories use a CODEOWNERS file. The
CODEOWNERSfile assigns responsibility for certain parts of the code to specific individuals or teams. When theCODEOWNERSfeature is enabled, only the code owner has the final authority to approve the pull request. Your review may not be a formal approval, but it does show confidence.Step 2: Communicate in pull requests
When an approval or request for changes is not yet needed, consider using comments. Comments enable you to inquire about the proposed change early in the review process. You don't need to wait until something is complete to make suggestions.
:keyboard: Activity: Comment on my pull request
Return to this pull request for my next comment