Topic on Talk:Gerrit/Commit message guidelines

Please improve "Good example"

3
Yaron Koren (talkcontribs)

The middle of the current "Good example" of a commit message is currently just nonsense placeholder text. It would be better if this were realistic text, given that this is supposed to help people learn what to write.

Jdforrester (WMF) (talkcontribs)

I don't understand. The example shows the title with modifier, a bunch of prose, and some references for future work, exactly as required. Inventing "nicer" prose seems very low value?

Yaron Koren (talkcontribs)

What should people write in that "bunch of prose" in the middle? How detailed should it be? Should it restate what's in the title? Should it mention which files have changed? The current example answers none of those questions.

Reply to "Please improve "Good example""