[GitHub] [guacamole-client] mike-jumper commented on pull request #615: GUACAMOLE-1322: Include SAML Plugin in Docker Image

[GitBox <gi...@apache.org>]

mike-jumper commented on pull request #615:
URL: https://github.com/apache/guacamole-client/pull/615#issuecomment-853496799


   > @mike-jumper I agree with your arguments and am always willing to improve. Before I do another rebase and alter my "fixed whitespaces" commit message, are the other ones I used somewhat OK (are they still within an acceptable range)?
   
   The other messages are better, for sure. If you'd like to improve those messages:
   
   * Avoid shorthand like "ext" and "env" for "extension" and "environment variable". It's unnecessarily obfuscated for something that's intended to be documentation.
   * Avoid describing what you're modifying by its filename alone - git already tells us this, and someone reading through the git history may not be as familiar with the purpose of each file. Describing things at a high level is better than saying "Update something.foo include BAR cfg"
   
   For example, consider:
   
   > GUACAMOLE-1322: Update build-guacamole.sh - include saml ext.
   > GUACAMOLE-1322: Update start.sh include SAML env
   
   vs.
   
   > GUACAMOLE-1322: Build and include SAML authentication extension within Docker image.
   > GUACAMOLE-1322: Add Docker environment variables for configuring SAML.
   


-- 
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:
users@infra.apache.org