Make PULL_REQUEST_TEMPLATE.md more inviting.

Add more clear and explanatory messaging to the pull-request template to help manage expectations and provide a welcoming experience.
This commit is contained in:
Jesse Rosenberger
2017-09-11 14:16:27 +02:00
committed by GitHub
parent d416ed913d
commit 929c6d5d60

View File

@@ -1,5 +1,26 @@
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
<!--
First, 🌠 thank you 🌠 for taking the time to consider a contribution to Meteor!
Note that we are unlikely to accept pull requests that add features without prior discussion. The best way to propose a feature is to open an issue first (in the [meteor/meteor-feature-requests](https://github.com/meteor/meteor-feature-requests/issues) repository) and discuss your ideas there before implementing them.
Here are some important details to follow:
Always follow the [contribution guidelines](https://github.com/meteor/meteor/blob/devel/Contributing.md) when submitting a pull request. In particular, make sure existing tests still pass, and add tests for all new behavior. When fixing a bug, you may want to add a test to verify the fix.
* ⏰ Your time is important
To save your precious time, if the contribution you are making will take more
than an hour, please make sure it has been discussed in an issue first.
This is especially true for feature requests!
* 💡 Features
Feature requests can be created and discussed by visiting:
https://github.com/meteor/meteor-feature-requests/issues
* 🕷 Bug fixes
These can be created and discussed in this repository. When fixing a bug,
please _try_ to add a test which verifies the fix. If you cannot, you should
still submit the PR but we may still ask you (and help you!) to create a test.
* 📖 Contribution guidelines
Always follow https://github.com/meteor/meteor/blob/master/Contributing.md
when submitting a pull request. Make sure existing tests still pass, and add
tests for all new behavior.
* ✏️ Explain your pull request
Describe the big picture of your changes here to communicate to what your
pull request is meant to accomplish. Provide 🔗 links 🔗 to associated issues!
We hope you will find this to be a positive experience! Open source contribution can be intimidating and we hope to alleviate that pain as much as possible. Without following these guidelines, you may be missing context which can help you succeed with your contribution which is why we encourage discussion first. Ultimately, there is no guarantee that we will be able to merge your pull-request but by following these guidelines, we can try to avoid disappointment.
-->