Conduct a Self-Review

Objective: Conduct a Self-Review

Welcome to Micro-Quest PY-1.4-BP3-MQ30: Conduct a Self-Review.

Our objective is to practice the code review process by reviewing your own code within a Pull Request.

Specifically, you will navigate to the 'Files changed' tab of your current Pull Request and add a line-specific comment on a line of code, suggesting a potential improvement or asking a clarifying question.

Check Spec: Verify Pull Request State

Before we begin, let's ensure your environment is ready.

Verification Steps:

  1. Confirm that you have an open Pull Request for the changes you recently pushed.
  2. Ensure you can access the Pull Request page on your Git hosting platform (e.g., GitHub).
  3. Verify that the Pull Request contains the code changes you intend to review.

Implement: Leave a Line Comment

Now, let's perform the self-review and add a comment.

Step by step checklist:

  1. Navigate to the 'Files changed' tab within your open Pull Request.
  2. Locate a specific line of code you want to comment on.
  3. Hover over the line number and click the '+' icon that appears to add a comment.
  4. Write your comment in the text box, suggesting an improvement or asking a question about that specific line.
  5. Submit your line-specific comment.

The following documentation sections are going to be helpful:

  • Anatomy of a Pull Request
  • Code Review: Leaving Comments

Validate: Confirm Comment Added

Let's verify that you have successfully added a line-specific comment to your Pull Request.

Verification Steps:

  1. Return to the 'Conversation' tab of your Pull Request.
  2. Confirm that your line-specific comment appears in the conversation timeline, linked to the file and line number you selected.

Verification Results:

  • ✅ Confirmed a line-specific comment was added to the Pull Request. All verification steps passed!

Documentation

Documentation not available for PY-1.4-BP3.