payload: {"action":"opened","issue":{"url":"https://api.github.com/repos/iov-one/weave/issues/466","repository_url":"https://api.github.com/repos/iov-one/weave","labels_url":"https://api.github.com/repos/iov-one/weave/issues/466/labels{/name}","comments_url":"https://api.github.com/repos/iov-one/weave/issues/466/comments","events_url":"https://api.github.com/repos/iov-one/weave/issues/466/events","html_url":"https://github.com/iov-one/weave/issues/466","id":427705733,"node_id":"MDU6SXNzdWU0Mjc3MDU3MzM=","number":466,"title":"Maintain a CHANGELOG file","user":{"login":"husio","id":1517,"node_id":"MDQ6VXNlcjE1MTc=","avatar_url":"https://avatars1.githubusercontent.com/u/1517?v=4","gravatar_id":"","url":"https://api.github.com/users/husio","html_url":"https://github.com/husio","followers_url":"https://api.github.com/users/husio/followers","following_url":"https://api.github.com/users/husio/following{/other_user}","gists_url":"https://api.github.com/users/husio/gists{/gist_id}","starred_url":"https://api.github.com/users/husio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/husio/subscriptions","organizations_url":"https://api.github.com/users/husio/orgs","repos_url":"https://api.github.com/users/husio/repos","events_url":"https://api.github.com/users/husio/events{/privacy}","received_events_url":"https://api.github.com/users/husio/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2019-04-01T13:28:46Z","updated_at":"2019-04-01T13:28:46Z","closed_at":null,"author_association":"MEMBER","body":"> [Don’t let your friends dump git logs into changelogs.](https://keepachangelog.com/en/1.0.0/)\r\n\r\nWhile picking up https://github.com/iov-one/weave/issues/437 I have realized that this will be a breaking change. This must be included in the README compability table later. It should be also included in our release description.\r\n\r\nOur [current approach](https://github.com/iov-one/ops/wiki/Release-notes) is to use a tool that generates release notes from commit messages. I believe we can do better.\r\n\r\nUnless someone would like to propose a better format, here is an example of a CHANGELOG file\r\n\r\n```\r\n## HEAD\r\n- Updated weave.Msg interface to contain Validate method\r\n- Added x/foo package for working with FOO coins\r\n- Removed the use of x/namecoin in cmd/bnsd\r\n\r\n## 0.13.1\r\n- Removed x/oldext extension. All code using it was deleted before.\r\n- Added more tests to the x/untested extension\r\n\r\n## 0.12.0\r\n- Added foo\r\n```\r\n\r\nWhen making a release, `HEAD` section is renamed to the release number and a new `## HEAD` section is aded.\r\nChangelog update is part of the functionality commit and should be reviewed as part of the changeset.\r\n\r\n## Acceptance criteria\r\n- [ ] Agree on a changelog file format and update https://github.com/iov-one/ops/wiki/How-do-we-work\r\n- [ ] Remove https://github.com/iov-one/ops/wiki/Release-notes\r\n- [ ] create a `CHANGELOG.md` file\r\n- [ ] backport last 3 releases into changelog file"}}
other: {"actor":{"display_login":"husio"}}