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:
Code destined for production is of the highest quality
Intentional shortcuts (technical debt) are commented on and confirmed
The greater team is aware of potential risks associated with changes
These broad responsibilities can include more specific goals, like:
Pointing out potential issues in code quality, security, or business logic
Suggesting other reviewers to the author, when warranted
Commenting on, approving, or requesting changes on the PR
Providing suggestions for alternate or better implementation details
Some repositories use a CODEOWNERS file. The CODEOWNERS file assigns responsibility for certain parts of the code to specific individuals or teams. When the CODEOWNERS feature 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
On the pull request, click Files changed
Hover over the line of code where you'd like to add a comment, and click the blue comment icon
In the comment window, type a question or leave a more general comment
When you're done, click Add single comment
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