-
Notifications
You must be signed in to change notification settings - Fork 610
perlhack: We use p.r's, not issue tracker; clarify commit msgs #24134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: blead
Are you sure you want to change the base?
Conversation
8fdb6a3 to
4609cac
Compare
|
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. |
|
Quoth @jkeenan
That sounds like a very good reason to document the standards. |
pod/perlhack.pod
Outdated
| % 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" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And more missing "commit"
|
Couple of quick ones:
|
This splits the explanation of a commit message into 1) title and 2) body, adding significant details.
4609cac to
4bbd0a2
Compare
|
guest20, It isn't |
|
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. |
tonycoz
left a comment
There was a problem hiding this 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.
This adds extensive discussion about what to put in a commit message, and especially the title.