{"action":"created","issue":{"url":"https://api.github.com/repos/melrief/pureconfig/issues/77","repository_url":"https://api.github.com/repos/melrief/pureconfig","labels_url":"https://api.github.com/repos/melrief/pureconfig/issues/77/labels{/name}","comments_url":"https://api.github.com/repos/melrief/pureconfig/issues/77/comments","events_url":"https://api.github.com/repos/melrief/pureconfig/issues/77/events","html_url":"https://github.com/melrief/pureconfig/issues/77","id":199663246,"number":77,"title":"Add a changelog","user":{"login":"ruippeixotog","id":613493,"avatar_url":"https://avatars.githubusercontent.com/u/613493?v=3","gravatar_id":"","url":"https://api.github.com/users/ruippeixotog","html_url":"https://github.com/ruippeixotog","followers_url":"https://api.github.com/users/ruippeixotog/followers","following_url":"https://api.github.com/users/ruippeixotog/following{/other_user}","gists_url":"https://api.github.com/users/ruippeixotog/gists{/gist_id}","starred_url":"https://api.github.com/users/ruippeixotog/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ruippeixotog/subscriptions","organizations_url":"https://api.github.com/users/ruippeixotog/orgs","repos_url":"https://api.github.com/users/ruippeixotog/repos","events_url":"https://api.github.com/users/ruippeixotog/events{/privacy}","received_events_url":"https://api.github.com/users/ruippeixotog/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-01-09T21:12:02Z","updated_at":"2017-01-09T21:26:42Z","closed_at":null,"body":"It's always good to have a log of what changed between releases. The commit tree sometimes works, but particularly for external users it makes sense to have a compact list enumerating what can users expect after an upgrade - which bugs were fixed, what improvements were made and what are the breaking changes. This last one is particularly important; if there is not a way to make things backwards compatible, it makes sense for users to have a place where they at least know what changed.\r\n\r\nAlthough they are not libraries, I take as good examples the changelogs for [terraform](https://github.com/hashicorp/terraform/blob/master/CHANGELOG.md) and [marathon](https://github.com/mesosphere/marathon/blob/master/changelog.md). They are well organized and easily searchable. Based on those, I adopted a much more modest version [for one of my libraries](https://github.com/ruippeixotog/scala-scraper/blob/master/CHANGELOG.md).\r\n\r\nWhat do you think of adding such a document? Adding it does not mean we shouldn't try to avoid breaking APIs, but it would give more information to users in case we decide to do it.\r\n\r\n(@melrief @jcazevedo @leifwickland I'm opening these issues to get your general opinion, if you think it's a good idea I don't mind writing it :))"},"comment":{"url":"https://api.github.com/repos/melrief/pureconfig/issues/comments/271412582","html_url":"https://github.com/melrief/pureconfig/issues/77#issuecomment-271412582","issue_url":"https://api.github.com/repos/melrief/pureconfig/issues/77","id":271412582,"user":{"login":"leifwickland","id":731622,"avatar_url":"https://avatars.githubusercontent.com/u/731622?v=3","gravatar_id":"","url":"https://api.github.com/users/leifwickland","html_url":"https://github.com/leifwickland","followers_url":"https://api.github.com/users/leifwickland/followers","following_url":"https://api.github.com/users/leifwickland/following{/other_user}","gists_url":"https://api.github.com/users/leifwickland/gists{/gist_id}","starred_url":"https://api.github.com/users/leifwickland/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/leifwickland/subscriptions","organizations_url":"https://api.github.com/users/leifwickland/orgs","repos_url":"https://api.github.com/users/leifwickland/repos","events_url":"https://api.github.com/users/leifwickland/events{/privacy}","received_events_url":"https://api.github.com/users/leifwickland/received_events","type":"User","site_admin":false},"created_at":"2017-01-09T21:26:42Z","updated_at":"2017-01-09T21:26:42Z","body":"I love change logs. I just hate writing them. ;-)\r\nI think it would be a terrific idea to at one, particularly to document the breaking changes we've been introducing."}}
{"actor":{"display_login":"leifwickland"}}