Skip to content

Conversation

@khwilliamson
Copy link
Contributor

This adds extensive discussion about what to put in a commit message, and especially the title.

  • This set of changes does not require a perldelta entry.

@jkeenan
Copy link
Contributor

jkeenan commented Jan 30, 2026

I do not approve of this pull request.

My initial reaction is: It doesn't practice what it preaches. Its subject line largely consists of "We use p.r's, not issue tracker" -- but the pull request itself only mentions 'issue tracker' in the deletion of two lines from the existing documentation.

More generally, what constitutes a good commit message is something that is always going to be up for argument. The content of this pull request would make a great post on a blog, but it's not something I think we need to codify in our official documentation at this time.

@guest20
Copy link

guest20 commented Jan 31, 2026

Quoth @jkeenan

what constitutes a good commit message is something that is always going to be up for argument

That sounds like a very good reason to document the standards.

pod/perlhack.pod Outdated
Comment on lines 361 to 363
% git -a -m'"Where": Add/clarify comments"
% git -a -m'"Where": Use more mnemonic variable name"
% git -a -m'"Where": Move ARGS_ASSERT to top of function"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And more missing "commit"

@guest20
Copy link

guest20 commented Feb 2, 2026

Couple of quick ones:

  • Should these PRs explicitly target bleed⸸?
  • What's the difference between perlhack, perlgit, and perlpolicy again?
  • Why is the "Super quick start guide" eleven steps and nearly 2 pages?
    __
    ⸸. and isn't it insensitive to haemophiliacs to call the branch bleed?

This splits the explanation of a commit message into 1) title and 2)
body, adding significant details.
@khwilliamson
Copy link
Contributor Author

guest20, It isn't bleed, it is blead. I don't know the differences between these various pods. That is above my pay grade, and thus the scope of this PR. And everything eventually targets blead. I guess it isn't super quick any more; but again that is outside the scope of this change

@khwilliamson
Copy link
Contributor Author

kid51, Obviously I think this is worth doing, or I wouldn't have proposed it. There will be commit messages that don't follow this. But it sets a goal to work towards, and text to give to new people on the project so it doesn't have to be repeated over and over. And this merely expands on what was already there, and in the same spirit.

Copy link
Contributor

@tonycoz tonycoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I've used git add -i once ever. /me hugs git gui and emacs magit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants