Skip to content

Use imperative for commit title; fix example #577

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

Closed
terryjreedy opened this issue Mar 9, 2020 · 2 comments · Fixed by #587
Closed

Use imperative for commit title; fix example #577

terryjreedy opened this issue Mar 9, 2020 · 2 comments · Fixed by #587

Comments

@terryjreedy
Copy link
Member

(See GvR's messages 363691 and 363740 on 2020 March 9 for https://bugs.python.org/issue39852.)
https://devguide.python.org/pullrequest/#making-good-commits has this descriptive example:
bpo-42: the spam module is now more spammy (GH-NNNN)
Guido strongly prefers the prevailing imperative style and would have that read
bpo-42: make the spam module more spammy (GH-NNNN)

Possibly split the following paragraph into two and after "... what the purpose of the commit is." add something like
"The imperative form is strongly preferred to a descriptive form such as 'the spam module is now more spammy'. Use git log --oneline to see existing title lines."

@gvanrossum
Copy link
Member

While we're at it, let's also codify that the commit "title" shouldn't end in a period.

Also, let's more directly reference this guide to writing commit messages: https://chris.beams.io/posts/git-commit/

@DahlitzFlorian
Copy link
Contributor

I would like to work on this if nobody is currently doing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants