this post was submitted on 15 Jan 2024
426 points (97.8% liked)

Programmer Humor

19519 readers
386 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

founded 1 year ago
MODERATORS
Feyter@programming.dev
anzo@programming.dev
BurningTurtle@programming.dev
pylapp@programming.dev
426
git commit -m "minor fixes" +26858 -69429 (feddit.de)
submitted 10 months ago by oeLLph@feddit.de to c/programmer_humor@programming.dev
73 comments fedilink hide all child comments
 
you are viewing a single comment's thread
view the rest of the comments
[โ€“] ekky@sopuli.xyz 9 points 10 months ago (1 children)

For those wondering how to exceed the 70 (80) recommended character limit and still follow best practices:

  1. Write the title on the first line, keep below 70 characters.
  2. Make two (2) newlines
  3. Write one or more descriptive paragraphs.

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.

[โ€“] r00ty@kbin.life 4 points 10 months ago

I generally write a single line summary and then a list of the specifics like:

Did stuff (except more detailed than that)
 - The first thing I did
  - Maybe some more detail about the first thing because there's a rationale to explain
 - The second thing I did
 - Third thing

Etc.