The commit message needs to match our commit message style guide.
Last active
March 13, 2016 15:45
-
-
Save jzaefferer/7043261 to your computer and use it in GitHub Desktop.
GitHub PR boilerplate
Thank you for the contribution. Can you please sign our CLA? http://contribute.jquery.org/CLA/
Thank you for the contribution. PRs like this need a unit test along with the actual change. That's the only way to make sure we fix the right problems without causing regressions.
Thank you for the contribution. PRs like this need a ticket on http://bugs.jqueryui.com with status "open" (verified to be valid) and a unit test along with the actual change. That's the only way to make sure we fix the right problems without causing regressions.
- sign CLA
- reference valid ticket, status 'open'
- include unit tests
- code adheres to style guide
- commit message adheres to style guide
I've added a 'pr-checklist.md'. We could have a bot add a comment with that checklist, which can include a few links. The bot can check the CLA, everything else would have to happen manually.
I'm going to start manually rocking this out for now.
Hi @username,
Thanks for taking the time to contribute to jQuery UI. We have the following requirements of pull requests before we can review them.
- Sign our CLA.
- A ticket with a reduced test case must be created on http://bugs.jqueryui.com and verified by the team.
- Include a unit test to ensure the fix works and prevent against regressions.
- Ensure code adheres to our style guide.
- Ensure commit messages adhere to our commit message style guide.
Copy and pastable:
Hi @username,
Thanks for taking the time to contribute to jQuery UI. We have the following requirements of pull requests before we can review them.
* [ ] Sign our [CLA](http://contribute.jquery.org/CLA/).
* [ ] A ticket with a reduced test case must be created on http://bugs.jqueryui.com and verified by the team.
* [ ] Include a unit test to ensure the fix works and prevent against regressions.
* [ ] Ensure code adheres to our [style guide](http://contribute.jquery.org/style-guide/js/).
* [ ] Ensure commit messages adhere to our [commit message style guide](http://wiki.jqueryui.com/w/page/25941597/Commit%20Message%20Style%20Guide).
Updated, copy and pastable, with new commit guideline link:
Hi @username,
Thanks for taking the time to contribute to jQuery UI. We have the following requirements of pull requests before we can review them.
* [ ] Sign our [CLA](http://contribute.jquery.org/CLA/).
* [ ] A ticket with a reduced test case must be created on http://bugs.jqueryui.com and verified by the team.
* [ ] Include a unit test to ensure the fix works and prevent against regressions.
* [ ] Ensure code adheres to our [style guide](http://contribute.jquery.org/style-guide/js/).
* [ ] Ensure commit messages adhere to our [commit message style guide](http://contribute.jquery.org/commits-and-pull-requests/#commit-guidelines).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The difficult thing to me is dealing with the various permutations of the requirements. The no-CLA portion is the only one that we can realistically automate (correct me if I'm wrong). Once we know they have signed the CLA perhaps we should respond with something like the following. We're using some flavor of this currently.
Hi @username,
Thanks for taking the time to contribute to jQuery UI. We have the following requirements of pull requests before we can review them.
Please send a new pull request after completing those steps, and make sure to follow our commit message style guide.
We'd have to manually remove the portions of that boilerplate that aren't relevant for a given PR, but I think we're always going to need somewhat of a manual process.