Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR table header, usefull for the docs? #6287

Closed
wouterj opened this issue Feb 17, 2016 · 7 comments
Closed

PR table header, usefull for the docs? #6287

wouterj opened this issue Feb 17, 2016 · 7 comments
Labels
actionable Clear and specific issues ready for anyone to take them.

Comments

@wouterj
Copy link
Member

wouterj commented Feb 17, 2016

Seems like OSS world is now really exicted about the latest feature of GitHub to provide PR description templates.

We do have such a summary table for the docs, but we've always be very not-strict with it (most important thing is to have a very low blocker for people to fix things). Does it make sense to include this template for the docs?

/cc @javiereguiluz @xabbuh @weaverryan

@theofidry
Copy link
Contributor

👍 it would actually make things easier as would avoid to have people check on the website for the template to copy/paste it :)

And it's still only a template, it doesn't force you to comply to it.

@javiereguiluz
Copy link
Member

We could show the template table, but prepeding it with a phrase like this: If your changes are not trivial, please fill in this table. Otherwise, delete it.

@weaverryan
Copy link
Member

👍 with friendly messaging of course so people know it's "ok" if they mess it up. I also copy and paste the table a lot.

@weaverryan weaverryan added actionable Clear and specific issues ready for anyone to take them. and removed needs comments labels Feb 21, 2016
@xabbuh
Copy link
Member

xabbuh commented Feb 23, 2016

I am not sure if we really need that table at all. Most PRs recently didn't include it and we didn't have any problems without it. What do you think about just removing it from the docs too instead of adding something new?

@wouterj
Copy link
Member Author

wouterj commented Mar 11, 2016

I think adding a message makes templates even less friendly: It's something that always has to be removed.

@javiereguiluz
Copy link
Member

In #6367 I'm proposing a simplification of the contribution process which removes this PR table.

@weaverryan
Copy link
Member

Closing this - now that the table is no longer included

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them.
Projects
None yet
Development

No branches or pull requests

5 participants