See #1059966: Change recommended format for commit messages (no more '#1234 by abc') where this is being discussed.

Let's work out the exact spec there, but we need Dreditor to be recommending the right thing ASAP for launch... :(

CommentFileSizeAuthor
#13 dreditor.commit-prefix.13.patch2.94 KBsun
#2 1061758-ab.patch574 bytesalanburke

Comments

alanburke’s picture

alanburke commented

For now, just add the Word 'Issue' in front, that will sort it.

alanburke’s picture

alanburke commented
Status: Active » Needs review
StatusFileSize
new 1061758-ab.patch574 bytes

Simple Patch for that.

nhck’s picture

nhck commented
Status: Needs review » Reviewed & tested by the community

Works for me.

helmo’s picture

helmo commented

Works also for me. This makes it line up with the git handbook and the "Git instructions" tab.

ericduran’s picture

ericduran commented

Seems simple enough, I just tested this and works as expected.

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Status: Reviewed & tested by the community » Fixed

Thanks for reporting, reviewing, and testing! Committed to master.

The reason for holding up this patch was that - in the few days I'm actively using git for d.o development now - this "Issue" prefix got seriously annoying already. It's also superfluous for CHANGELOG.txt entries.

We should change that rule/guideline and use a simple hyphen (- #123456 by ...) instead.

But I'm not entirely sure where one would post this proposal.

ericduran’s picture

ericduran commented

@sun, Makes sense -- I believe there is still some discussion going on over at http://groups.drupal.org/node/140309

Thanks for the commit.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Priority: Critical » Major
Status: Closed (fixed) » Active

Until the guideline is formally changed, Dreditor should conform to the community-agreed upon one, which is "Issue".

Feel free to kick-start the discussion at http://groups.drupal.org/node/140309 and build consensus around the new change though.

sun’s picture

sun
Primary language German
Location Karlsruhe
commented

Well, moving discussions about actual issues to g.d.o has a 100% chance of getting nowhere.

Was kick-started a long time ago: http://groups.drupal.org/node/140309#comment-474599

marvil07’s picture

marvil07 commented

Right, it's easier to track specific discussions here at issue queue.

I am copying a comment from sdboyer in the g.d.o thread that IMHO make a pretty good summary of the reasons because why we want to use "Issue" instead of "-":

Because prepending "Issue" adds some semantic value to the self-contained commit message (even if it's implied, it makes explicit the fact that the following number refers to an issue). The hyphen adds no semantic value; if anything, it detracts from the self-contained nature of a commit message by suggesting that this commit is a bullet in some larger list. What list? All commits? If it needs to be formatted as a list, that can (and should) be done external to the commit message. The hyphen is semantically null, it's got no business being somewhere that human eyes read.

Plus, "- " would be a massive Drupalism.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented

Ok, we can have the discussion here, too. :)

I agree with Sam/marvil07. "Issue " is English. "- " is a Drupalism.

And you can't unilaterally force decisions like this in a tool that's intended for use by the wider contributor community. The Git migration team already went through the process of building community buy-in in order to arrive at the "Issue " prefix. If you want to change it from the standard, then the onus is on you to build enough support for it. If you are unable to rally this kind of unilateral support, then the current standard stays.

So this change needs to be reverted. After that, you can feel free to mark this issue postponed pending outcome of a larger community discussion on the standard (I don't really care where, but it needs to be widely advertised to invite participation).

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Status: Active » Fixed
StatusFileSize
new dreditor.commit-prefix.13.patch2.94 KB

No one needs to enforce anything on anyone.

Thanks for reporting, reviewing, and testing! Committed to master.

Status: Fixed » Closed (fixed)
Issue tags: -git phase 2, -git sprint 10

Automatically closed -- issue fixed for 2 weeks with no activity.

Issue tags: +git phase 2, +git sprint 10

Restoring issue tags, see #2125755: System messages removed all issue tags during D7 upgrade.