windows-itpro-docs icon indicating copy to clipboard operation
windows-itpro-docs copied to clipboard

Published 20 hours ago • verified publisher icon MicrosoftDocs

Add GitHub PR Template to encourage linking issues

Open aisgbnok opened this issue 2 years ago • 1 comments

Why

I thought it would possibly help to provide more structure to PR descriptions. As outlined in #10584, I have noticed that sometimes PRs are opened and merged without the issue they address being closed. My main goal with adding a template like this is to encourage PR authors to use keywords like closes so that the issue they are fixing is automatically closed.

This is a suggestion that I would be happy to have merged into this repo. Edits from maintainers are allowed, so feel free to modify it right here, but if Microsoft reviewers want to write their own from scratch feel free to close this.

  • Closes #10584

Changes

This PR adds a GitHub Pull Request template.

I took inspiration from a few other templates while creating this:

  • https://github.com/MicrosoftDocs/Contribute/blob/main/.github/PULL_REQUEST_TEMPLATE.md
  • https://github.com/github/docs/blob/main/.github/PULL_REQUEST_TEMPLATE.md

aisgbnok avatar Jun 05 '22 01:06 aisgbnok

@JohanFreelancer9, I've committed the suggestions from your review. As always thank you for your eagle eyes!

aisgbnok avatar Jul 15 '22 05:07 aisgbnok

@aczechowsk, no problem. I'm just happy it was helpful and hopefully will be for those who contribute to this repo. Thanks as always! 👍

aisgbnok avatar Sep 01 '22 19:09 aisgbnok