{"action":"created","issue":{"url":"https://api.github.com/repos/Symplify/Symplify/issues/1124","repository_url":"https://api.github.com/repos/Symplify/Symplify","labels_url":"https://api.github.com/repos/Symplify/Symplify/issues/1124/labels{/name}","comments_url":"https://api.github.com/repos/Symplify/Symplify/issues/1124/comments","events_url":"https://api.github.com/repos/Symplify/Symplify/issues/1124/events","html_url":"https://github.com/Symplify/Symplify/issues/1124","id":362474781,"node_id":"MDU6SXNzdWUzNjI0NzQ3ODE=","number":1124,"title":"[ChangelogLinker] CLI tool to assist with a commit message","user":{"login":"azdanov","id":6123841,"node_id":"MDQ6VXNlcjYxMjM4NDE=","avatar_url":"https://avatars2.githubusercontent.com/u/6123841?v=4","gravatar_id":"","url":"https://api.github.com/users/azdanov","html_url":"https://github.com/azdanov","followers_url":"https://api.github.com/users/azdanov/followers","following_url":"https://api.github.com/users/azdanov/following{/other_user}","gists_url":"https://api.github.com/users/azdanov/gists{/gist_id}","starred_url":"https://api.github.com/users/azdanov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/azdanov/subscriptions","organizations_url":"https://api.github.com/users/azdanov/orgs","repos_url":"https://api.github.com/users/azdanov/repos","events_url":"https://api.github.com/users/azdanov/events{/privacy}","received_events_url":"https://api.github.com/users/azdanov/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-09-21T06:40:11Z","updated_at":"2018-09-21T11:33:54Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"Here's a couple of example projects [jakeasmith/commit](https://github.com/jakeasmith/commit) and [commitizen/cz-cli](https://github.com/commitizen/cz-cli).\r\n\r\nThis way a newcomer who is contributing to a repository that uses `ChangelogLinker` don't need to worry about formatting the commit message properly.\r\n\r\nThis is a good explanation from `commitizen/cz-cli` repo about the benefits:\r\n\r\n> When you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit (though that can still be helpful). No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\nIt is possible to use `cz-cli` via globally installed `npm` package. But it's inconvenient and needs a custom `adapter` to suit a specific message style.\r\n\r\nSo something that is installable with composer with a predefined set of rules would be good."},"comment":{"url":"https://api.github.com/repos/Symplify/Symplify/issues/comments/423501853","html_url":"https://github.com/Symplify/Symplify/issues/1124#issuecomment-423501853","issue_url":"https://api.github.com/repos/Symplify/Symplify/issues/1124","id":423501853,"node_id":"MDEyOklzc3VlQ29tbWVudDQyMzUwMTg1Mw==","user":{"login":"azdanov","id":6123841,"node_id":"MDQ6VXNlcjYxMjM4NDE=","avatar_url":"https://avatars2.githubusercontent.com/u/6123841?v=4","gravatar_id":"","url":"https://api.github.com/users/azdanov","html_url":"https://github.com/azdanov","followers_url":"https://api.github.com/users/azdanov/followers","following_url":"https://api.github.com/users/azdanov/following{/other_user}","gists_url":"https://api.github.com/users/azdanov/gists{/gist_id}","starred_url":"https://api.github.com/users/azdanov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/azdanov/subscriptions","organizations_url":"https://api.github.com/users/azdanov/orgs","repos_url":"https://api.github.com/users/azdanov/repos","events_url":"https://api.github.com/users/azdanov/events{/privacy}","received_events_url":"https://api.github.com/users/azdanov/received_events","type":"User","site_admin":false},"created_at":"2018-09-21T11:33:54Z","updated_at":"2018-09-21T11:33:54Z","author_association":"CONTRIBUTOR","body":"I use these tools for [semantic-release/semantic-release](https://github.com/semantic-release/semantic-release) which generates a changelog and release notes. Also, there are ways to [prevent a commit](https://github.com/marionebl/commitlint) when the message format is wrong, so something automated makes the process smoother.\r\n\r\nPersonally, I prefer [commitizen/cz-cli](https://github.com/commitizen/cz-cli) and [angular commit convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit). Took me a while to get used to, but now I can't create a commit using a 'normal' style.\r\n\r\nFor example in angular [every commit](https://github.com/angular/angular/commits/master) is uniform, which makes reading the history easier. I guess if this is not common in the PHP community then there is no need for such tools yet.\r\n\r\nI haven't actually done any research on how commit messages are enforced in larger projects (Laravel, Symfony, Wordpress). Maybe there are tools that I'm not aware of."}}
{"actor":{"display_login":"azdanov"}}