4 ms·

> Please consider using these emoji Fine with that, but please also write longer descriptive commit messages. For example: > git log -1 3b5bb1501ce7af8f857a

by leejo 12y ago

> Please consider using these emoji Fine with that, but please also write longer descriptive commit messages. For example: > git log -1 3b5bb1501ce7af8f857af7621fc0d5f86fb4fa93 commit 3b5bb1501ce7af8f857af7621fc0d5f86fb4fa93 Author: Ben Ogle <ogle.ben@gmail.com> Date: Tue Jan 6 17:09:59 2015 -0800 :lipstick: Tells me nothing. Nothing! At a glance the commit messages for the atom repo are poor: atom > git-mean-commit-message-bytes | grep '>' >ALL 147 You would hope github and git users would grok the power of git's commit messages, but hey ho...

igorgue 12y ago
Well, if you read their guide it says that :lipstick: means: "improving the format/structure of the code" So I guess this code just changes spaces or something like that, I don't know I'm just reading what they do, they might do something else, I'm just following the instructions that everyone contributing to the code should.
- leejo 12y ago
  OK, the guidelines explain the meaning but the message is still not descriptive enough. What happens when one of those commits breaks something? If i ran a bisect and the offending commit had the message: :lipstick: I would be tempted to revert the commit because the message tells me nothing about why the change was made. A commit message should be future proofed, even if the code it relates to can never be.
bradleybuda 12y ago
I'm guessing that's intentional. The idea is that if you are going to reformat code, it should be the only thing you do in a change; in other words, don't commit a change that both changes the semantics of the code and changes the formatting. The principle is that formatting is orthogonal to other work and therefore shouldn't be mixed in. Unless you do something wrong, formatting changes are harmless so they can be scanned past by someone reviewing a changelog. Here's a good discussion of the practice on StackOverflow: http://stackoverflow.com/questions/2214480/committing-when-changing-source-formatting http://stackoverflow.com/questions/2214480/committing-when-c...
- leejo 12y ago
  > Unless you do something wrong Therein lies the rub; when something goes wrong i want a commit message that explains why that formatting change was made. :lipstick: - add missing # char, as per conventions Would have taken all of 5 extra seconds to write and is a lot better future proofed. Remember, a commit message should explain why something changed and not just what changed.

by leejo 12y ago

igorgue 12y ago

Well, if you read their guide it says that :lipstick: means: "improving the format/structure of the code" So I guess this code just changes spaces or something like that, I don't know I'm just reading what they do, they might do something else, I'm just following the instructions that everyone contributing to the code should.

leejo 12y ago
OK, the guidelines explain the meaning but the message is still not descriptive enough. What happens when one of those commits breaks something? If i ran a bisect and the offending commit had the message: :lipstick: I would be tempted to revert the commit because the message tells me nothing about why the change was made. A commit message should be future proofed, even if the code it relates to can never be.

bradleybuda 12y ago

I'm guessing that's intentional. The idea is that if you are going to reformat code, it should be the only thing you do in a change; in other words, don't commit a change that both changes the semantics of the code and changes the formatting. The principle is that formatting is orthogonal to other work and therefore shouldn't be mixed in. Unless you do something wrong, formatting changes are harmless so they can be scanned past by someone reviewing a changelog. Here's a good discussion of the practice on StackOverflow: http://stackoverflow.com/questions/2214480/committing-when-changing-source-formatting http://stackoverflow.com/questions/2214480/committing-when-c...

leejo 12y ago
> Unless you do something wrong Therein lies the rub; when something goes wrong i want a commit message that explains why that formatting change was made. :lipstick: - add missing # char, as per conventions Would have taken all of 5 extra seconds to write and is a lot better future proofed. Remember, a commit message should explain why something changed and not just what changed.