this post was submitted on 15 Jan 2024
423 points (97.7% liked)
Programmer Humor
19821 readers
6 users here now
Welcome to Programmer Humor!
This is a place where you can post jokes, memes, humor, etc. related to programming!
For sharing awful code theres also Programming Horror.
Rules
- Keep content in english
- No advertisements
- Posts must be related to programming or programmer topics
founded 2 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
When there's a limit to the size of a commit message it does make it difficult to actually list all the changes, so sometimes this is all you can write.
I know in theory you're meant to commit little and often, but in practice it doesn't always work out that way.
Even if you have a big commit, you can always write something more descriptive than this. And commit messages can be huge, so the limit shouldn't be an excuse to write a useless message.
For those wondering how to exceed the 70 (80) recommended character limit and still follow best practices:
The first line will be shown as commit message, and the full text can usually be viewed by checking out the commit. Sentences can span multiple lines, but try to keep the line length below 70 characters for best readability.
This off the top of my head, so feel free to correct me if I've misremembered the best practices.
I generally write a single line summary and then a list of the specifics like:
Etc.