Conversation
|
The preceding sentence is hard to understand. The checklist doesn't guide you through the PR process, it provides a few checklists for the process. I don't think either sentence is needed. Less is more. I would make the bullets sentences (that is, end with punctuation). Consider the second list as
|
|
+1 on removing the two sentences at the top and making the bullets sentences. I would drop the Acrolinx bullet, as we get plenty of reminders of that in the Acrolinx emails and it's included in the "blocking issues" page so it's a duplicate here. Consider making just one list. Even if you're just updating content, it can't hurt to be aware of whether it has links in TOC or LP, as some articles still don't. And as part of updating content you might have added an external dependency.
Move the "More than 20 commits" bullet to first place Move the "Automatic acceptance" bullet to the top of the list before "Next steps" and reword: If the PR doesn't meet automatic acceptance criteria, can it be split up into multiple PRs? |
|
@Rick-Anderson @tdykstra The thing I worry about with removing the sentences is that this content is for both content writers and PMs/Devs who may be contributing to docs. I don't want to expend from some formality to be courteous to the PG members who are assisting us with content updates. |
|
If we keep them, they could be shortened to something like "Thank you for providing a valuable update to our documentation. The following checklist may help reduce delays in your contribution getting merged." |
Microsoft Docs pull request checklist
Thank you for providing a valuable update to our documentation, your contribution will help customers with their new journey or continued success on the Azure platform.
The following checklist will assist you with the PR process, if required, to help reduce delays in your contribution getting merged.
I updated content
ms.author,authorandmanageras requiredI created new content
Next steps