{"action":"created","issue":{"url":"https://api.github.com/repos/inuitcss/inuitcss/issues/229","repository_url":"https://api.github.com/repos/inuitcss/inuitcss","labels_url":"https://api.github.com/repos/inuitcss/inuitcss/issues/229/labels{/name}","comments_url":"https://api.github.com/repos/inuitcss/inuitcss/issues/229/comments","events_url":"https://api.github.com/repos/inuitcss/inuitcss/issues/229/events","html_url":"https://github.com/inuitcss/inuitcss/pull/229","id":188300678,"number":229,"title":"[refs #218] Create a changelog file","user":{"login":"herzinger","id":1102234,"avatar_url":"https://avatars.githubusercontent.com/u/1102234?v=3","gravatar_id":"","url":"https://api.github.com/users/herzinger","html_url":"https://github.com/herzinger","followers_url":"https://api.github.com/users/herzinger/followers","following_url":"https://api.github.com/users/herzinger/following{/other_user}","gists_url":"https://api.github.com/users/herzinger/gists{/gist_id}","starred_url":"https://api.github.com/users/herzinger/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/herzinger/subscriptions","organizations_url":"https://api.github.com/users/herzinger/orgs","repos_url":"https://api.github.com/users/herzinger/repos","events_url":"https://api.github.com/users/herzinger/events{/privacy}","received_events_url":"https://api.github.com/users/herzinger/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":10,"created_at":"2016-11-09T17:07:24Z","updated_at":"2016-11-09T22:46:02Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/inuitcss/inuitcss/pulls/229","html_url":"https://github.com/inuitcss/inuitcss/pull/229","diff_url":"https://github.com/inuitcss/inuitcss/pull/229.diff","patch_url":"https://github.com/inuitcss/inuitcss/pull/229.patch"},"body":"Create `CHANGELOG.md`, with a pattern to follow, and add instructions on how to update it to `CONTRIBUTING.md`"},"comment":{"url":"https://api.github.com/repos/inuitcss/inuitcss/issues/comments/259548759","html_url":"https://github.com/inuitcss/inuitcss/pull/229#issuecomment-259548759","issue_url":"https://api.github.com/repos/inuitcss/inuitcss/issues/229","id":259548759,"user":{"login":"herzinger","id":1102234,"avatar_url":"https://avatars.githubusercontent.com/u/1102234?v=3","gravatar_id":"","url":"https://api.github.com/users/herzinger","html_url":"https://github.com/herzinger","followers_url":"https://api.github.com/users/herzinger/followers","following_url":"https://api.github.com/users/herzinger/following{/other_user}","gists_url":"https://api.github.com/users/herzinger/gists{/gist_id}","starred_url":"https://api.github.com/users/herzinger/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/herzinger/subscriptions","organizations_url":"https://api.github.com/users/herzinger/orgs","repos_url":"https://api.github.com/users/herzinger/repos","events_url":"https://api.github.com/users/herzinger/events{/privacy}","received_events_url":"https://api.github.com/users/herzinger/received_events","type":"User","site_admin":false},"created_at":"2016-11-09T22:46:02Z","updated_at":"2016-11-09T22:46:02Z","body":"@anselmh don't mention it. \r\n\r\nI would just like to clarify that I'm all for using releases. But as I said, one does not eliminate the other. Actually, all the options you listed should be used, to some degree.\r\n\r\n* **Commits history** is an inherent part of git, so no discussion here.\r\n* The real shine in **releases** appears when used in combination with **git tags**.\r\n* Maintaining a **`CHANGELOG.md`** makes it easier to document releases, while bringing extra value by itself.\r\n\r\nThe extra value comes from:\r\n\r\n1. Having in one, clear and easy to find, full log of all changes in the project, across versions.\r\n2. Making new changes easier to track during pre-releases, since you are adding them along the way.\r\n3. Having the logs as part of the version control.\r\n\r\n>* hard to tell people to include meaningful changelog messages with their Pull Requests\r\n* hard to tell people they need to update the file all the time before releases (and commit it during the git version update commit)\r\n\r\nThat's why I included it in our `CONTRIBUTING.md` file. We already follow and impose a series of unusual guidelines, I don't think this extra one should be a problem. Enforcing the usage is easy, since all contributions come from pull requests that, obligatorily, need to be approved before merge. Even if the core team choses to add the entries themselves, it's still easier to update somewhere along the way, at the time the changes are make, ratter than only at the time of the version bumps."}}
{"actor":{"display_login":"herzinger"}}