diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e3a9700..5d7bae4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,33 @@ +Thank you so much for your contribution! We are working to improve the way we record +why pull requests and features are accepted. Please use this space to fully explain +the value of this pull request in plain English. + +Don’t assume that the reader has your specialized subject matter expertise. Writing +in a way that a general technical audience can follow allows other people to help +review, including our phenomenally helpful community members such as yourself! ❤️ + +For example, instead of something like "use the correct mod" you might instead write +"the frobnicator mod was deprecated in 2017. This PR switches to the drop-in +replacement, libfrobnicator. It should have no end-user changes and so the tests +did not need to be updated." Include sources or references if you’ve got them handy. + +If this is correcting a defect, describe what the defect was and the problems it +could cause. Explain why this PR offers the correct solution and any alternatives +you considered. Describe any potential side effects of the fix. + +If this is a new feature, then describe what the feature does and why it’s useful +for a general audience. Explain how you’ve made sure that it’s not designed as a +special case scenario and that it follows industry standard practices for the +technology this module manages. + +Thank you again. Community contributions are essential to our ecosystem. + + ## Summary Provide a detailed description of all the changes present in this pull request. ## Additional Context -Add any additional context about the problem here. +Add any additional context about the problem here. - [ ] Root cause and the steps to reproduce. (If applicable) - [ ] Thought process behind the implementation. @@ -12,4 +37,4 @@ Mention any related issues or pull requests. ## Checklist - [ ] 🟢 Spec tests. - [ ] 🟢 Acceptance tests. -- [ ] Manually verified. (For example `puppet apply`) \ No newline at end of file +- [ ] Manually verified. (For example `puppet apply`)