Review a PR

This page describes how to review a PR created by someone else. The next page describes how to create your own PR.

When someone wants you to review a PR, this person generally tags you as a reviewer on the PR. In the GitHub notification you receive, you can click the link to go to the PR.

The simplest way to learn how to contribute to a project is to begin reviewing PRs that other contributors have created. You can add suggestions in their PRs for improving content, thereby build the confidence that you need to create your own PRs.

Being an effective reviewer assumes that you are familiar with all the resources listed in PyAnsys documentation resources.

Add a comment

On the Conversation page of the PR, you can add a general comment on the overall PR by scrolling to the bottom of the page, entering your comment in the Write tab, and clicking Comment.

On the Files changed page of the PR, you can add a general comment on a single changed line or multiple consecutive changed lines in a file. You can also add a comment that suggests specific changes to a single line or multiple consecutive lines.

If the PR includes changes to multiple files, the Files changed page has two panes. The left pane displays a list of all changed files, and the right pane displays the files themselves, with changes highlighted in green. To quickly see the changes made to a particular file, click its entry in the left pane.

Add a general comment on a line

You can add a general comment on a line:

1. Click the plus sign to the right of the line number.

   

2. In the window that opens, type your comment.

3. Click Add single comment to add your comment and close the window.

Add a comment suggesting a change to a single line

You can add a comment suggesting a change to a single line:

1. Click the plus sign to the right of the line number.

2. In the window that opens, click the Add a suggestion icon:

   

   GitHub copies the content of line, placing it in a suggestion tag in the window’s Write tab. The suggestion tag begins and ends with triple backticks (```) like this:

   ```suggestion
       This test shows how composite data can be stored.
   ```
   

3. Within the suggestion tag, edit the content to reflect your suggested changes.

4. If you want to provide any information about your suggested change, type it directly under the three backticks that close the suggestion tag:

   ```suggestion
       This test shows how composite data can be stored.
   ```
   Here is were you type information about your suggested change.
   

5. Click Add single comment to add your comment and close the window.

Add a comment suggesting changes to multiple lines

You can add a comment suggesting changes to multiple consecutive lines:

1. Click the plus sign to the right of the first line number that you want to comment on and then drag the mouse to the last line number you want to comment on before releasing the mouse button.

   The selected lines are highlighted in yellow.

2. In the window that opens, click the Add a suggestion icon.

   GitHub places the content of the selected lines within a suggestion tag in the window’s Write tab.

3. Within the suggestion tag, edit the content to reflect your suggested changes.

4. If you want to provide a comment about your suggested changes, type it directly under the three backticks that close the suggestion tag.

5. Click Add single comment to add your comment and close the window.

Submit your review

When you finish reviewing the PR, submit your review:

1. In the upper right corner of the GitHub window, click Review changes .

   The Finish your review window opens.

2. Leave a comment about your review.

3. Choose the Comment, Approve, or Request changes option.

4. Click Submit review.