[PR Workflow] Add "Next steps to merge this PR" comment

[konrad-jamrozik]

There are some issues with the current ARM PR review workflow:

• [PR Workflow] Improvements to API spec PR review process #6610

Currently the main methods of guiding PR authors we have are:

• The ARM review workflow diagram
• The "Automated merging requirements met" check

The problem with the diagram is that it doesn't tell the PR author where they are on that diagram.

The problem with the check is two-fold.

First, once it is green, there is still more work to do - user needs to get the PR approved and denote they wish to get their PR merged, even after it is approved. Quite often they need extra time before they want to merge their spec updates.

Second, such check would be a weird place to tell people their "next steps". Instead, it is, well, a check.

This work item is a bout adding a PR comment "Next steps to get this PR merged" that will complement the diagram and the check. It will tell the PR author where they are on the diagram and exactly what they need to do. The comment may use the check as a dependency, or the PR author may look at the check to do a "sanity check" if they understand what is going on.

Once this new comment is in place, we might end up getting rid of some of the other comments, to reduce the amount of text the PR authors have to read, and thus increasing the probability they will actually read it.

Additional discussion here.

Related work:

• [PR Workflow] Make "getting help" support information easily discoverable by specs PR authors #6286
• [PR Workflow] Improvements to API spec PR review process #6610
• [Documentation] Migrate spec PR review workflow support docs to EngHub #6618

PRs

• https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/489860
• https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/490299
• https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/491153
• https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/491560
• https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/493202