{"action":"created","issue":{"url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org/issues/64","repository_url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org","labels_url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org/issues/64/labels{/name}","comments_url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org/issues/64/comments","events_url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org/issues/64/events","html_url":"https://github.com/conventional-changelog/conventionalcommits.org/pull/64","id":338730231,"node_id":"MDExOlB1bGxSZXF1ZXN0MTk5NTkwNzM5","number":64,"title":"BREAK: feat: indicate breaking changes in header via \"BREAK: \" prefix","user":{"login":"apetro","id":952283,"node_id":"MDQ6VXNlcjk1MjI4Mw==","avatar_url":"https://avatars3.githubusercontent.com/u/952283?v=4","gravatar_id":"","url":"https://api.github.com/users/apetro","html_url":"https://github.com/apetro","followers_url":"https://api.github.com/users/apetro/followers","following_url":"https://api.github.com/users/apetro/following{/other_user}","gists_url":"https://api.github.com/users/apetro/gists{/gist_id}","starred_url":"https://api.github.com/users/apetro/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apetro/subscriptions","organizations_url":"https://api.github.com/users/apetro/orgs","repos_url":"https://api.github.com/users/apetro/repos","events_url":"https://api.github.com/users/apetro/events{/privacy}","received_events_url":"https://api.github.com/users/apetro/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-07-05T21:22:22Z","updated_at":"2018-07-05T21:23:09Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org/pulls/64","html_url":"https://github.com/conventional-changelog/conventionalcommits.org/pull/64","diff_url":"https://github.com/conventional-changelog/conventionalcommits.org/pull/64.diff","patch_url":"https://github.com/conventional-changelog/conventionalcommits.org/pull/64.patch"},"body":"BREAKING CHANGE: adds new \"BREAK: \" prefix before type in header in commits including breaking API changes. Tools written to the spec before this feature may fail to parse or flag as non-compliant commit messages using this feature. Breaking change commit messages written to prior versions of this spec will not be compliant with versions of the spec with this change.\r\n\r\nTools can regain spec compliance by adding support for parsing the new \"BREAK: \" prefix.\r\n\r\nFor a commit that includes API-breaking changes, that fact is the most important thing to say about the commit, so lead with it in the commit message header. Indicating breakingness in the commit message header makes API breakages more apparent on skim in more contexts.\r\n"},"comment":{"url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org/issues/comments/402856685","html_url":"https://github.com/conventional-changelog/conventionalcommits.org/pull/64#issuecomment-402856685","issue_url":"https://api.github.com/repos/conventional-changelog/conventionalcommits.org/issues/64","id":402856685,"node_id":"MDEyOklzc3VlQ29tbWVudDQwMjg1NjY4NQ==","user":{"login":"apetro","id":952283,"node_id":"MDQ6VXNlcjk1MjI4Mw==","avatar_url":"https://avatars3.githubusercontent.com/u/952283?v=4","gravatar_id":"","url":"https://api.github.com/users/apetro","html_url":"https://github.com/apetro","followers_url":"https://api.github.com/users/apetro/followers","following_url":"https://api.github.com/users/apetro/following{/other_user}","gists_url":"https://api.github.com/users/apetro/gists{/gist_id}","starred_url":"https://api.github.com/users/apetro/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apetro/subscriptions","organizations_url":"https://api.github.com/users/apetro/orgs","repos_url":"https://api.github.com/users/apetro/repos","events_url":"https://api.github.com/users/apetro/events{/privacy}","received_events_url":"https://api.github.com/users/apetro/received_events","type":"User","site_admin":false},"created_at":"2018-07-05T21:23:09Z","updated_at":"2018-07-05T21:23:09Z","author_association":"CONTRIBUTOR","body":"Alternative solution to #63 or #43 . \r\n\r\nUsing \"BREAK:\" might be better than a sigil (#43) in that \r\n\r\n+ \"BREAK:\" may be more readily understandable by a reader less familiar with the spec (whereas one would need to learn the meaning of the sigil). \r\n\r\nUsing \"BREAK:\" might be better than tweaking the capitalization of the type (#63) in that \r\n\r\n+ \"BREAK:\" may be more readily understandable by a reader less familiar with the spec (whereas one would need to learn the meaning of different type capitalizations).\r\n+ developers may not always be taking care with that capitalization. To the extent that developers inadvertently use ALL-CAPS types, those will be false signals of API breakage.\r\n+ It may be desirable for capitalization not to have semantic meaning in the commit messages.\r\n\r\nUsing \"BREAK:\" does consume 6 characters of the header, however.\r\n\r\nI'm not sure what the right solution is here. I do think the header should reflect breakingness, rather than breakingness only being reflected in the body or footer."}}
{"actor":{"display_login":"apetro"}}