DORKAG Help

Pull Request Review

Pull Request Timeline

When it comes to reviewing code changes, the pull request timeline is an essential tool for tracking the progression of a pull request.

The timeline provides a chronological overview of significant events and interactions within a pull request. It's a key tool for tracking the progress, understanding the history, and identifying areas of discussion or contention in a pull request.

  1. Accessing the Timeline

    • Open a pull request to view its details.

    • Navigate to the 'Timeline' file editor.

  2. Understanding Timeline Entries

    The timeline will display a variety of events, including:

    • Comments and replies made by reviewers and contributors.

    • Commits added or associated with the pull request.

    • Status updates, such as when a pull request is opened, reviewed, or merged.

    • System notifications, like CI/CD results or automated checks.

    • Manual events like label additions or changes in assignees.

  3. Interacting with Timeline Entries

    • You can click on specific timeline entries to view more details or jump to related files or discussions.

    • Some entries allow for direct interaction, like replying to comments or viewing commit diffs.

    The pull request timeline is an invaluable tool for staying updated on the progression and discussions surrounding your code changes.

Pull Request Status

When you are reviewing a pull request, you can see the status of the pull request in the Pull Requests tool window.

The status of a pull request is displayed based on the checks that are configured in the Azure DevOps repository.

For example, you can see the following statuses:

  • Build and Check status

    An Action link is attached to this status when clicked a clickable list of Azure DevOps pipelines are presented. Click on one of them to open them in the browser.

  • Work Items linked to the pull request

    If your Project's admin has set a blocking merge for unlinked work items, you will see an error in the pull request status.

  • Reviewers votes

  • Other statuses

Review Actions

With AZD you can review a Pull Request without leaving your IDE, it lets you do all the following:

Comment Actions

Comment on a change made by the author, or comment on the Pull Request as a whole.

comment-on-pr
You can reply, edit, delete your comments, or thumbs up the comments left by others.

You can resolve a comment with all the statuses comment supported in Azure DevOps.

Vote Actions

Approve, Approve with suggestions, Reset your vote, Wait for changes or Reject the Pull Request.

approve-reject
Request Review Actions

Request a review from a specific reviewer or from all reviewers.

request-review
Merge Actions

Merge, Rebase, Squash the Pull Request, or close it without merging.

merge-pr

You can also delete the source branch after merging, edit the merge commit message, and choose to close associated work items.

Publish Draft Actions

When you are ready to share your draft Pull Request, you can publish it to make it visible to others. You can also go the other way around and save a published Pull Request as a draft.

publish-draft
Description Actions

Edit the description of the Pull Request, or add a description if it's missing.

When creating the PR from the IDE, AZD is filling the description with the commit messages. You can edit the description before triggering the PR creation.

View and apply the suggested changes

If the maintainers of the original repository left comments or made suggestions with regard to your changes, you can view and apply them directly from Jetbrains' IDEA.

  1. In the main menu, go to Git | Azure DevOps | View Pull Requests.

  2. In the list of pull requests, select the one you want to work with and double-click it.

    The IDE opens an overview of the selected pull request.

    view_and_apply_single_pr

    • Next to the title, there is the pull request id number. Click it if you want to open the pull request on Azure DevOps.

    • Click the View Timeline button to open the pull request timeline.

    • To filter the list of changed files, select the commit you want to investigate in Changes from.

    • Right-click any file to open the context menu for this file.

    • In case a reviewer has left any comments or suggestions, there is a counter with the number of comments in the list of files.

  3. Double-click a file to view the suggested changes and comments.

  4. You can either resolve a comment, reply to it or add or remove a Like emoji like.

    comment_in_editor_diff

    If you are the comment author, you can Edit or Delete the comment as well.

  5. If the reviewer has left a suggestion, you'll see the diff between your code and suggested one and can either Apply locally (applies a patch to the working copy) or Commit (opens a commit message pop-up).

    apply_suggestion_diff_editor

  6. After you finished working on the pull request, you can re-request review, vote by approving or rejecting the pull request, merge pull request or close it.

    vote_status_options

Last modified: 19 November 2024