mike-jumper commented on pull request #615: URL: https://github.com/apache/guacamole-client/pull/615#issuecomment-851674125
> You need to re-do all of your commits to have the issue tag at the front, like this: `GUACAMOLE-1322: fixed whitespaces` Also, _please_ do not use a commit message like "fixed whitespaces". There just isn't any context there. Like a code comment, a good commit message should describe the nature of the change, not the literal change: https://www.codelord.net/2015/03/16/bad-commit-messages-hall-of-shame/ For example, after seeing your commit, I still had no idea what whitespace issue you were referring to or why anything needed to be fixed. I looked at the content of the commit itself and was able to see for myself, but that sort of information should already be apparent from the message. With something like: > GUACAMOLE-1322: fixed whitespaces A developer looking through the git history is left wondering what happened. If something is wrong with the content of your change, the developer goes to the relevant commit message to understand your reasoning for that change, and here that would be absent. On the other hand, something like: > GUACAMOLE-1322: Correct indentation of SAML property assignments to match established code style. is very clear. If (somehow) the change didn't achieve what it aimed at achieving, that would be apparent even weeks to months down the line. No commit or change is too trivial to warrant a good message. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
