Simplify contributing.md; move details into GitHub templates #1530
Conversation
|
For the issue template, what about https://gist.github.com/remear/442a71e3167cf8214cf3? The goal being to maximize the balance between asking for information and making it easier to fill in that information. |
|
|
||
| - [ ] A description of the changes proposed in the pull request. | ||
| - [ ] Any areas or issues reviewer should pay attention to? (comments in diff okay). | ||
| - [ ] Update `/docs` to include, whenever possible, a new, suitable recommendation about how to use |
There was a problem hiding this comment.
That's something I would actually expect to find in the CONTRIBUTING part rather than the PR template. I would rather know before submitting a PR that I should add documentation.
|
@groyoh Can I get your thoughts on these changes. |
| @@ -0,0 +1,25 @@ | |||
| #### Expected behavior vs actual behavior | |||
| <br><br> | |||
There was a problem hiding this comment.
curious why the <br>'s in the markdown?
There was a problem hiding this comment.
Line spacing to make it easy to move the cursor directly to where you want to type. I couldn't find a way to get it to do that in GitHub's markdown. If there's a way I'm all for changing it.
Simplify contributing.md; move details into GitHub templates
per https://github.com/blog/2111-issue-and-pull-request-templates
Follows #1485