{"action":"opened","issue":{"url":"https://api.github.com/repos/NixOS/nixpkgs/issues/19126","repository_url":"https://api.github.com/repos/NixOS/nixpkgs","labels_url":"https://api.github.com/repos/NixOS/nixpkgs/issues/19126/labels{/name}","comments_url":"https://api.github.com/repos/NixOS/nixpkgs/issues/19126/comments","events_url":"https://api.github.com/repos/NixOS/nixpkgs/issues/19126/events","html_url":"https://github.com/NixOS/nixpkgs/issues/19126","id":180452030,"number":19126,"title":"Improve guidelines for commit messages","user":{"login":"bachp","id":333807,"avatar_url":"https://avatars.githubusercontent.com/u/333807?v=3","gravatar_id":"","url":"https://api.github.com/users/bachp","html_url":"https://github.com/bachp","followers_url":"https://api.github.com/users/bachp/followers","following_url":"https://api.github.com/users/bachp/following{/other_user}","gists_url":"https://api.github.com/users/bachp/gists{/gist_id}","starred_url":"https://api.github.com/users/bachp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bachp/subscriptions","organizations_url":"https://api.github.com/users/bachp/orgs","repos_url":"https://api.github.com/users/bachp/repos","events_url":"https://api.github.com/users/bachp/events{/privacy}","received_events_url":"https://api.github.com/users/bachp/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2016-10-01T11:30:03Z","updated_at":"2016-10-01T11:30:03Z","closed_at":null,"body":"## Issue description\r\n\r\nNixpkgs already has some guidelines how to write commit messages in CONTRIBUTING.md.\r\nIt describes how to structure the message.\r\n\r\nMost commits follow this guideline which is very good.\r\nHowever one Problem is that many people do really good changes in their commit but for somebody not directly involved it is really hard to understand why.\r\n\r\nIn my opinion it's very important to have this \"why\" in the commit message, especially if the project has many collaborators of various degree of involvement. One project I found to do this very well is [OpenEmbedded](https://github.com/openembedded/openembedded-core/commit/9e9875fc19df6b924aa7f9d06e7b4e07222d0799).\r\n\r\nI propose to add a section to CONTRIBUTING.md that encourages to explain a bit more why the changes were made. Maintainers should then encourage people to follow this guidelines when reviewing PRs.\r\n\r\n"}}
{"actor":{"display_login":"bachp"}}