mike-jumper commented on pull request #312:
URL: https://github.com/apache/guacamole-server/pull/312#issuecomment-723257068


   Regarding the above, I'd like to also point out the commit messages 
themselves:
   
   ![Screenshot of commit 
messages](https://user-images.githubusercontent.com/4632905/98405991-06cce400-2022-11eb-9616-c5c324c72b72.png)
   
   Just like the comments, these should be aimed at capturing what someone 
reviewing the code later will need to understand about the context of your 
changes.
   
   Something like "Fixed the audio issues on MME" doesn't capture what is being 
fixed and why. If someone goes through this in a `git bisect` later, finds that 
this is the change that broke something, they are going to have quite a bit of 
further research ahead of them before they find out what issue that is and why 
these changes were made.
   
   A messages like "Added some comments" is only negligibly better that a 
message like "Changed some code". What were you doing and why? If the change 
doesn't feel significantly separate your earlier commits, it can just be 
squashed into the most relevant commit. If it does, then there should be some 
context that can be provided. Presumably those comments were to document 
something specific?


----------------------------------------------------------------
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]


Reply via email to