Add pull request template #670
Conversation
| @@ -0,0 +1,18 @@ | |||
| _Please tick all applicable boxes, fill in the **bold** fields, and remove these instructions from your PR._ | |||
There was a problem hiding this comment.
How about replacing the _ with <!-- and -->? This way the text won't show when posted (and you don't need the 'remove these instructions from your PR' part).
Also, it's easier for people to tick the boxes after they've posted the PR (they can just click), so maybe change the instructions to: "Please fill in the bold fields, submit your pull request and then tick the applicable boxes"?
There was a problem hiding this comment.
Great thinking on the _ vs HTML comments 👍 I will carry that out.
I don't know about your other suggestion. Once they have submitted the PR, mails go out to all watchers with incomplete information, which is undesirable IMHO. So that why I dislike it and will not change it unless I'm a minority that has that opinion.
I fully agree that ticking the boxes is easier from the interface than from GFM, but I think the time gain is negligible since:
- Most people only submit 1 PR ever (for their own list), and even if you would look at the top committers, the distribution of number of commits drops off very steeply: 70, 18, 11, 6, 4, 3 (x5), 2 (x20), 1 (all the rest) and is evidence for the same phenomenon.
- The difference in time (between clicking and typing) is going to be 5 seconds tops (probably just 2 seconds). If that is too much, I honestly doubt that the person involved is able to maintain a high-quality awesome list in his very limited time.
There was a problem hiding this comment.
I didn't think about that, typing an x isn't too much of a problem so I think you're right for keeping it how it is.
- Now uses comments instead of italics - No need to remove it from the template.
| @@ -0,0 +1,18 @@ | |||
| <!--Please fill in the **bold** fields, and tick all applicable boxes.--> | |||
There was a problem hiding this comment.
This needs to tell the user to click the Preview tab.
|
Add a checkbox for having a license and the correct one. Linkify to https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license Add a checkbox for having contribution guidelines. Linkify to https://github.com/sindresorhus/awesome/blob/master/awesome.md#include-contribution-guidelines |
- reduce cruft around URL, - linkify some terms, - remove trick question tick box at the end, - mention preview tab, - ask for contribution guidelines, - ask for license.
|
@sindresorhus Thanks for the review, I hope you like it better now. |
sindresorhus
changed the title
|
Thank you! :) |
This introduces a pull request template and hence fixes #650.