{"action":"created","issue":{"url":"https://api.github.com/repos/stripe/stripe-dotnet/issues/1026","repository_url":"https://api.github.com/repos/stripe/stripe-dotnet","labels_url":"https://api.github.com/repos/stripe/stripe-dotnet/issues/1026/labels{/name}","comments_url":"https://api.github.com/repos/stripe/stripe-dotnet/issues/1026/comments","events_url":"https://api.github.com/repos/stripe/stripe-dotnet/issues/1026/events","html_url":"https://github.com/stripe/stripe-dotnet/pull/1026","id":264334477,"number":1026,"title":"Experiment with Markdown changelog","user":{"login":"brandur","id":96890,"avatar_url":"https://avatars1.githubusercontent.com/u/96890?v=4","gravatar_id":"","url":"https://api.github.com/users/brandur","html_url":"https://github.com/brandur","followers_url":"https://api.github.com/users/brandur/followers","following_url":"https://api.github.com/users/brandur/following{/other_user}","gists_url":"https://api.github.com/users/brandur/gists{/gist_id}","starred_url":"https://api.github.com/users/brandur/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/brandur/subscriptions","organizations_url":"https://api.github.com/users/brandur/orgs","repos_url":"https://api.github.com/users/brandur/repos","events_url":"https://api.github.com/users/brandur/events{/privacy}","received_events_url":"https://api.github.com/users/brandur/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2017-10-10T18:42:35Z","updated_at":"2017-10-11T19:43:13Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/stripe/stripe-dotnet/pulls/1026","html_url":"https://github.com/stripe/stripe-dotnet/pull/1026","diff_url":"https://github.com/stripe/stripe-dotnet/pull/1026.diff","patch_url":"https://github.com/stripe/stripe-dotnet/pull/1026.patch"},"body":"Here we experiment a bit with our changelog format by changing\r\n`CHANGELOG` to `CHANGELOG.md` and refactoring.\r\n\r\nThe new format is largely based on keepachangelog.com [1], but I've\r\nstreamlined it a little bit (by removing subsubheadings) because I find\r\nthe default a little tedious to keep up-to-date and visually noisy\r\nenough that it's hard to skim.\r\n\r\nAdvantages of the new format:\r\n\r\n* Linkable headers\r\n* Nice in-browser rendering (standard Markdown)\r\n* Easy to copy and paste additions right into the releases page when\r\n  cutting a new release\r\n* Real links to all PRs that introduced changes\r\n* ~~Text wrapping when in plaintext for readability that way too~~ Actually, it's a little strange but the releases page doesn't render Markdown like other places in GitHub and will not concatenate wrap lines. Given that, it's probably easiest to set no line wrapping for `CHANGELOG.md` so that it's still easy to copy and paste.\r\n\r\n[Here's a link to the rendered version](https://github.com/stripe/stripe-dotnet/blob/brandur-md-changelog/CHANGELOG.md).\r\n\r\n@remi-stripe What do you think? If we can find a format that works here, I'm\r\nthinking we just move all our libraries over to look exactly the same.\r\n\r\n[1] http://keepachangelog.com/en/0.3.0/"},"comment":{"url":"https://api.github.com/repos/stripe/stripe-dotnet/issues/comments/335925618","html_url":"https://github.com/stripe/stripe-dotnet/pull/1026#issuecomment-335925618","issue_url":"https://api.github.com/repos/stripe/stripe-dotnet/issues/1026","id":335925618,"user":{"login":"brandur-stripe","id":23105990,"avatar_url":"https://avatars3.githubusercontent.com/u/23105990?v=4","gravatar_id":"","url":"https://api.github.com/users/brandur-stripe","html_url":"https://github.com/brandur-stripe","followers_url":"https://api.github.com/users/brandur-stripe/followers","following_url":"https://api.github.com/users/brandur-stripe/following{/other_user}","gists_url":"https://api.github.com/users/brandur-stripe/gists{/gist_id}","starred_url":"https://api.github.com/users/brandur-stripe/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/brandur-stripe/subscriptions","organizations_url":"https://api.github.com/users/brandur-stripe/orgs","repos_url":"https://api.github.com/users/brandur-stripe/repos","events_url":"https://api.github.com/users/brandur-stripe/events{/privacy}","received_events_url":"https://api.github.com/users/brandur-stripe/received_events","type":"User","site_admin":false},"created_at":"2017-10-11T19:43:13Z","updated_at":"2017-10-11T19:43:13Z","author_association":"OWNER","body":"Remi, going to merge this one so I don't have to keep rebasing it.\r\n\r\nLuckily changing the format of the changelog is not breaking, so we can tweak it in the future if we find it not to our liking."}}
{"actor":{"display_login":"brandur-stripe"}}