{"action":"created","issue":{"url":"https://api.github.com/repos/nengo/nengo/issues/1158","repository_url":"https://api.github.com/repos/nengo/nengo","labels_url":"https://api.github.com/repos/nengo/nengo/issues/1158/labels{/name}","comments_url":"https://api.github.com/repos/nengo/nengo/issues/1158/comments","events_url":"https://api.github.com/repos/nengo/nengo/issues/1158/events","html_url":"https://github.com/nengo/nengo/pull/1158","id":174112709,"number":1158,"title":"Make PR template more concise.","user":{"login":"jgosmann","id":850157,"avatar_url":"https://avatars.githubusercontent.com/u/850157?v=3","gravatar_id":"","url":"https://api.github.com/users/jgosmann","html_url":"https://github.com/jgosmann","followers_url":"https://api.github.com/users/jgosmann/followers","following_url":"https://api.github.com/users/jgosmann/following{/other_user}","gists_url":"https://api.github.com/users/jgosmann/gists{/gist_id}","starred_url":"https://api.github.com/users/jgosmann/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jgosmann/subscriptions","organizations_url":"https://api.github.com/users/jgosmann/orgs","repos_url":"https://api.github.com/users/jgosmann/repos","events_url":"https://api.github.com/users/jgosmann/events{/privacy}","received_events_url":"https://api.github.com/users/jgosmann/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/nengo/nengo/labels/discussion","name":"discussion","color":"207de5"},{"url":"https://api.github.com/repos/nengo/nengo/labels/needs%20review","name":"needs review","color":"eb6420"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2016-08-30T20:08:15Z","updated_at":"2016-08-30T21:07:23Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/nengo/nengo/pulls/1158","html_url":"https://github.com/nengo/nengo/pull/1158","diff_url":"https://github.com/nengo/nengo/pull/1158.diff","patch_url":"https://github.com/nengo/nengo/pull/1158.patch"},"body":"**Description:**\r\nGiven today's discussions, I propose some changes to the PR template to make it more concise.\r\n\r\nThere are two changes (in two separate commits):\r\n* The description and motivation/context sections are sometimes overlapping, or sometimes it is better to start with the motivation before describing the changes. Consolidating them gives some more flexibility in this.\r\n* The “Where should a reviewer start?” section is rarely useful. I went through a bunch of recent PRs and they pretty much all say “Files changed tab” (or something equivalent) or “read discussion X, than look at changes”. I found two PRs where actually some additional information was provided: #1112 and #1035. Given the rare use I could see completely removing that section, but for now I just inserted “Files changed.” as a default.\r\n\r\n**Where should a reviewer start?**\r\nFiles changed.\r\n\r\n**How long should this take to review?**\r\n<!--- Please estimate if this PR is a quick, average, or lengthy PR. -->\r\n<!--- Take into account both the size and complexity of the changes. -->\r\n<!--- Also note if this is a timely PR that should be reviewed by a certain date. -->\r\n<!--- Leave only the line that applies below: -->\r\n\r\n- Quick (less than 40 lines changed or changes are straightforward)\r\n\r\n**Types of changes:**\r\n<!--- What types of changes does your code introduce? -->\r\n<!--- Leave all lines that apply below: -->\r\n\r\n- New feature (non-breaking change which adds functionality) :question: \r\n\r\n**Checklist:**\r\n<!--- Go over all the following points. Put an `x` in all the boxes that apply. -->\r\n<!--- If a box is not applicable, please justify below the checklist. -->\r\n<!--- If you're unsure about any of these, don't hesitate to ask. -->\r\n<!--- We're here to help! -->\r\n\r\n- [x] I have read the **CONTRIBUTING.rst** document.\r\n- [x] I have updated the documentation accordingly.\r\n- [x] I have included a changelog entry. [not needed as no change to Nengo itself]\r\n- [x] I have added tests to cover my changes. [nothing to test]\r\n- [x] All new and existing tests passed."},"comment":{"url":"https://api.github.com/repos/nengo/nengo/issues/comments/243581292","html_url":"https://github.com/nengo/nengo/pull/1158#issuecomment-243581292","issue_url":"https://api.github.com/repos/nengo/nengo/issues/1158","id":243581292,"user":{"login":"tbekolay","id":203709,"avatar_url":"https://avatars.githubusercontent.com/u/203709?v=3","gravatar_id":"","url":"https://api.github.com/users/tbekolay","html_url":"https://github.com/tbekolay","followers_url":"https://api.github.com/users/tbekolay/followers","following_url":"https://api.github.com/users/tbekolay/following{/other_user}","gists_url":"https://api.github.com/users/tbekolay/gists{/gist_id}","starred_url":"https://api.github.com/users/tbekolay/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tbekolay/subscriptions","organizations_url":"https://api.github.com/users/tbekolay/orgs","repos_url":"https://api.github.com/users/tbekolay/repos","events_url":"https://api.github.com/users/tbekolay/events{/privacy}","received_events_url":"https://api.github.com/users/tbekolay/received_events","type":"User","site_admin":false},"created_at":"2016-08-30T21:07:23Z","updated_at":"2016-08-30T21:07:23Z","body":"I agree, there's a lot of overlap between the description and motivation and context, so I'm +1 on combining them. However, I've found that I prefer the motivation and context being front and center, because the description should follow naturally from that (and is already sort of hinted at in the title of the PR), so I swapped them in my fixup. You can see that a lot of my recent [commit messages](https://github.com/nengo/nengo/commits/master) start by talking about the context first... not that my commit messages are the gold standard or anything, it's just been a helpful thing I've been using to structure my messages lately.\r\n\r\nI'm not sure that saying \"Files changed\" is particularly helpful since we talk about reading diffs at length in the [reviewing guidelines](https://github.com/nengo/nengo/blob/master/docs/contributing.rst#reviewing), so I instead moved the \"where should a reviewer start\" section to after the length estimation, and in the comments noted that this section should be removed unless you just said that the PR is lengthy (or average and complicated), like we do with the Interactions section.\r\n\r\nFinally, since we're touching this file anyway and it's come up a few times, I added a new type of change, which is a Non-code change (which encompasses tests, docs, build scripts, and other meta things, like this PR!)\r\n\r\nThanks for taking another look at the template, it's hard to know what will end up being onerous / useful until we use a bunch. Definitely better with these changes!"}}
{"actor":{"display_login":"tbekolay"}}