Skip to content

Conversation

@SyntaxC4
Copy link
Member

@SyntaxC4 SyntaxC4 commented Oct 24, 2017

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

  • Update article metadata especially ms.date, ms.author, author and manager as required
  • Acrolinx score of 80 or above
  • Free of blocking issues
  • Content review: Product Group, Marketing and MVC steward

I created new content

  • Topic in ToC and/or landing page?
  • Publish external dependencies (such as GitHub Repository)
  • Acrolinx score of 80 or above
  • Free of blocking issues
  • Content review: Product Group, Marketing and MVC steward

Next steps

@Rick-Anderson
Copy link

Rick-Anderson commented Nov 3, 2017

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 guide you through the PR process, if required, to help reduce delays in your contribution getting merged.

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

  • Everything in the previous list
  • Topic in ToC and/or landing page?

@tdykstra
Copy link

tdykstra commented Nov 5, 2017

+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.

Follow the PR Automation guidance to continue. Add sign-off comment when ready to merge.

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?

@SyntaxC4
Copy link
Member Author

SyntaxC4 commented Nov 7, 2017

@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.

@tdykstra
Copy link

tdykstra commented Nov 7, 2017

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."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants