{"action":"closed","issue":{"url":"https://api.github.com/repos/olivierlacan/keep-a-changelog/issues/8","repository_url":"https://api.github.com/repos/olivierlacan/keep-a-changelog","labels_url":"https://api.github.com/repos/olivierlacan/keep-a-changelog/issues/8/labels{/name}","comments_url":"https://api.github.com/repos/olivierlacan/keep-a-changelog/issues/8/comments","events_url":"https://api.github.com/repos/olivierlacan/keep-a-changelog/issues/8/events","html_url":"https://github.com/olivierlacan/keep-a-changelog/issues/8","id":39447063,"number":8,"title":"Parseable variations (Markdown, RST, Wiki, text/plain)","user":{"login":"prof-milki","id":8345441,"avatar_url":"https://avatars.githubusercontent.com/u/8345441?v=3","gravatar_id":"","url":"https://api.github.com/users/prof-milki","html_url":"https://github.com/prof-milki","followers_url":"https://api.github.com/users/prof-milki/followers","following_url":"https://api.github.com/users/prof-milki/following{/other_user}","gists_url":"https://api.github.com/users/prof-milki/gists{/gist_id}","starred_url":"https://api.github.com/users/prof-milki/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/prof-milki/subscriptions","organizations_url":"https://api.github.com/users/prof-milki/orgs","repos_url":"https://api.github.com/users/prof-milki/repos","events_url":"https://api.github.com/users/prof-milki/events{/privacy}","received_events_url":"https://api.github.com/users/prof-milki/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2014-08-04T18:26:59Z","updated_at":"2016-04-15T03:41:32Z","closed_at":"2016-04-15T03:41:32Z","body":"Agreeing on a common format is difficult.\r\n\r\nFor freshcode.club (a freshmeat replacement), I've decided to allow a few variations, but still enforce a common scheme (which k-a-c captures pretty well).\r\nHere primarily to keep it parsable without too many false positives:  \r\n[http://fossil.include-once.org/freshcode/wiki/AutoupdateChangelog](http://fossil.include-once.org/freshcode/wiki/AutoupdateChangelog)\r\n\r\nI'd have presumed Markdown was more common, but in particular Python projects (well, if they have a changelog anyway) seem to lean towards ReStructuredText rather ([PEP287](http://legacy.python.org/dev/peps/pep-0287/) and hence PyPI support).\r\n\r\nPlain text structures are not that far off from MarkDown either, and I'd need to support it since CPAN::Canages::Spec is the only widespread format.\r\n\r\nWhat I personally find more relevant to differentiate release note changelogs from commit logs is leaving out e.g. attributions `(written by <author@example.com)` or ticket numbers `(Closes #257)` which are largely irrelevant to actual feature changes. Maybe the summarization intent of changelogs could be more stressed?\r\n"}}