Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

2. Limit the subject line to 50 characters

Note

The advice to limit the subject line to 50 characters is well-intentioned - it seems very hard to follow. Check the git log of main, ui and other Magnolia projects and try to find commit message subjects which use not more than 50 characters.

To keep the commit message subject clean and short is very important, but very often it seems impossible to follow the "50 characters rule".

If you can manage not to use more than 72 (see rule #6) - seems fine.

(Personal note from Christoph Meier)

 

50 characters is not a hard limit, just a rule of thumb. Keeping subject lines at this length ensures that they are readable, and forces the author to think for a moment about the most concise way to explain what's going on.

...