{"action":"created","issue":{"url":"https://api.github.com/repos/openpathsampling/openpathsampling/issues/641","repository_url":"https://api.github.com/repos/openpathsampling/openpathsampling","labels_url":"https://api.github.com/repos/openpathsampling/openpathsampling/issues/641/labels{/name}","comments_url":"https://api.github.com/repos/openpathsampling/openpathsampling/issues/641/comments","events_url":"https://api.github.com/repos/openpathsampling/openpathsampling/issues/641/events","html_url":"https://github.com/openpathsampling/openpathsampling/issues/641","id":191288553,"number":641,"title":"Changelog?","user":{"login":"dwhswenson","id":8178546,"avatar_url":"https://avatars.githubusercontent.com/u/8178546?v=3","gravatar_id":"","url":"https://api.github.com/users/dwhswenson","html_url":"https://github.com/dwhswenson","followers_url":"https://api.github.com/users/dwhswenson/followers","following_url":"https://api.github.com/users/dwhswenson/following{/other_user}","gists_url":"https://api.github.com/users/dwhswenson/gists{/gist_id}","starred_url":"https://api.github.com/users/dwhswenson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dwhswenson/subscriptions","organizations_url":"https://api.github.com/users/dwhswenson/orgs","repos_url":"https://api.github.com/users/dwhswenson/repos","events_url":"https://api.github.com/users/dwhswenson/events{/privacy}","received_events_url":"https://api.github.com/users/dwhswenson/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":11,"created_at":"2016-11-23T14:41:43Z","updated_at":"2016-11-26T21:40:25Z","closed_at":null,"body":"One of the recommendations in the E-CAM project is that we use a proper change log. I'm unsure whether we need this, since I think that the git repository and GitHub serve this role for us. When I need the change log, I either use git commands or I browse the merged PRs on GitHub (for example, when doing release notes).\r\n\r\nI think the PRs give a better picture of what has changed than the change log would, and I think a change log would be a lot of maintenance for rapidly changing code (the change log would soon be longer than the code itself.) However, I'm not totally opposed to the idea. One possibility might be to maintain a change log starting with 1.0 and through our 1.x series?\r\n\r\nPutting this issue up for discussion; it was listed as something to be included for the E-CAM modules, but our detailed PRs might meet the same needs. (I think we take the attitude that a public GitHub acts as additional documentation, as well as a collaborative development platform.)\r\n\r\nThoughts, @jhprinz?"},"comment":{"url":"https://api.github.com/repos/openpathsampling/openpathsampling/issues/comments/263087548","html_url":"https://github.com/openpathsampling/openpathsampling/issues/641#issuecomment-263087548","issue_url":"https://api.github.com/repos/openpathsampling/openpathsampling/issues/641","id":263087548,"user":{"login":"dwhswenson","id":8178546,"avatar_url":"https://avatars.githubusercontent.com/u/8178546?v=3","gravatar_id":"","url":"https://api.github.com/users/dwhswenson","html_url":"https://github.com/dwhswenson","followers_url":"https://api.github.com/users/dwhswenson/followers","following_url":"https://api.github.com/users/dwhswenson/following{/other_user}","gists_url":"https://api.github.com/users/dwhswenson/gists{/gist_id}","starred_url":"https://api.github.com/users/dwhswenson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dwhswenson/subscriptions","organizations_url":"https://api.github.com/users/dwhswenson/orgs","repos_url":"https://api.github.com/users/dwhswenson/repos","events_url":"https://api.github.com/users/dwhswenson/events{/privacy}","received_events_url":"https://api.github.com/users/dwhswenson/received_events","type":"User","site_admin":false},"created_at":"2016-11-26T21:40:25Z","updated_at":"2016-11-26T21:40:25Z","body":"Well, this is why I'm asking Alan to clarify. This has happened a few times before (over the coding guidelines conflicting with PEP8, and over Doxygen being explicitly required, which conflicts with our Sphinx/numpydoc style). What I see is that the SW team cares about the big picture of writing good software, and trying to train scientific software developers to use best practices that scientists often ignore. I expect that their advice here will also be to do something that meets the essential goal of summarizing changes for more casual contributors, while not drowning us in extra metadata overhead.\r\n\r\nBut before we start managing a changelog, I want to make sure it will meet the E-CAM guidelines."}}
{"actor":{"display_login":"dwhswenson"}}