-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
Improve PR template to encourage appropriate context in descriptions #4815
Improve PR template to encourage appropriate context in descriptions #4815
Conversation
This doesn't follow the current PR template :) |
While fixing up the templates again, is it worth turning the suggestions into HTML comments? This would allow contributors to keep each suggestion so they don't miss anything and have something to reference. But maybe that's just overkill/not as readable 😅 |
I think the readability argument is critical here: most of the tools (like Github's PR tool or Gitkraken) won't render the HTML as you're editing, which makes that style of changes relatively confusing to users. |
Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com>
Co-authored-by: François <mockersf@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly minor nitpicks
Co-authored-by: Thierry Berger <contact@thierryberger.com>
Co-authored-by: Thierry Berger <contact@thierryberger.com>
Objective
Context
stretch2
library, which I also maintain.Feedback wanted
Are there any sections that can be safely cut?Can I make this even shorter?