Skip to content
This repository has been archived by the owner on Aug 23, 2021. It is now read-only.

Github commit messages standard #21

Open
MarcusJones opened this issue Jul 5, 2018 · 1 comment
Open

Github commit messages standard #21

MarcusJones opened this issue Jul 5, 2018 · 1 comment
Labels
DevOps DevOps
Milestone

Comments

@MarcusJones
Copy link
Contributor

What I do for summary line is to prepend a simple code from i.e. following list:
add
change
merge
fix
etc...

In my (LIMITED) experience I like to commit often, so I keep the messages to the summary line only. Further documentation I usually include in PR for feature branches... For discussion!

@aaitor aaitor added this to To do in Engineering Board Aug 8, 2018
@aaitor aaitor added this to the 18Q3 milestone Aug 8, 2018
@aaitor aaitor added the DevOps DevOps label Aug 8, 2018
@jcortejoso
Copy link
Contributor

I agree with @MarcusJones. A short, direct and standard subject line improve readability, mainly when the git log is presented in the oneline format. As some recommendations from https://chris.beams.io/posts/git-commit/:

The seven rules of a great Git commit message:

  1. Separate subject from body with a blank line
    
  2. Limit the subject line to 50 characters
    
  3. Capitalize the subject line
    
  4. Do not end the subject line with a period
    
  5. Use the imperative mood in the subject line
    
  6. Wrap the body at 72 characters
    
  7. Use the body to explain what and why vs. how
    

This should be considered as a recommendation, or is preferably to force some rules using git hooks?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
DevOps DevOps
Projects
Development

No branches or pull requests

3 participants