Opened 5 years ago

Closed 5 years ago

#17334 closed Cleanup/optimization (fixed)

Document the commit message style for backports

Reported by: Aymeric Augustin Owned by: Christopher Medrela
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

As discussed in #django-dev, it seems that the appropriate style is:

[1.3.X] Fixed #**** -- Frobnicated spam around. Backport of r*****.

Attachments (2)

17334.diff​ (972 bytes) - added by Christopher Medrela 5 years ago.
17334_v2.diff​ (1.1 KB) - added by Christopher Medrela 5 years ago.

Download all attachments as: .zip

Change History (6)

Changed 5 years ago by Christopher Medrela

Attachment: 17334.diff​ added

comment:1 Changed 5 years ago by Christopher Medrela

Has patch: set
Owner: changed from nobody to Christopher Medrela
Status: new → assigned

comment:2 Changed 5 years ago by Ramiro Morales

Patch needs improvement: set

Why do the proposed patch remove the following text?

Write detailed commit messages in the past tense, not present tense.
* Good: "Fixed Unicode bug in RSS API." 
* Bad: "Fixes Unicode bug in RSS API." 
* Bad: "Fixing Unicode bug in RSS API."

I'm not aware of any discussion and agreement about that requirement being changed or relaxed.

Changed 5 years ago by Christopher Medrela

Attachment: 17334_v2.diff​ added

comment:3 Changed 5 years ago by Christopher Medrela

Patch needs improvement: unset

Sorry for this stupid mistake. The pattern of commit messages is in past tense, so I thought the problem of tenses disappeared. I didn't notice that the problem actually did not disappeare because the pattern doesn't mention tense of description.

comment:4 Changed 5 years ago by Tim Graham

Resolution: → fixed
Status: assigned → closed

In [17294]:

Fixed #17334 - Documented the commit message style for backports; thanks krzysiumed for the draft patch.

Note: See TracTickets for help on using tickets.
Back to Top