Page MenuHomePhabricator

CodeReview e-mails (for new comments, follow-up revisions, etc.) should include commit summary of original revision for context
Closed, ResolvedPublic

Description

Currently, CodeReview e-mails look something like this:


User "Hashar" posted a comment on MediaWiki.r77186.

Full URL: http://www.mediawiki.org/wiki/Special:Code/MediaWiki/77186#c11289

Comment:

spaces fixed in a future revision.

There's no way to know which revision this is referring to, which is really annoying. Perhaps it should include a truncated commit summary?


Version: unspecified
Severity: enhancement

Details

Reference
bz26120

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 21 2014, 11:21 PM
bzimport set Reference to bz26120.
bzimport added a subscriber: Unknown Object (MLST).

http://www.faqs.org/rfcs/rfc2822.html

"There are two limits that this standard places on the number of characters in a line. Each line of characters MUST be no more than 998 characters, and SHOULD be no more than 78 characters, excluding the CRLF."

78 seems reasonable

Though, "[MediaWiki] [r75646]: New comment added" is 40 alone...

Since the emails going out now include the revision and the revision being followed up, I think this is fixed.

(In reply to comment #2)

Since the emails going out now include the revision and the revision being
followed up, I think this is fixed.

Re-opening this. I'm fairly sure this isn't fixed, but the opening comment is kind of confusing.

When you get an e-mail about a new comment on a revision, it looks like something like this:


User "Platonides" posted a comment on MediaWiki.r70270.

Full URL: http://www.mediawiki.org/wiki/Special:Code/MediaWiki/70270#c13834

Comment:

I don't see the need for history either. Why history and not edit, for example? If any, I would modify whatlinkshere-links so that those links can be created in MediaWiki namespace.

This is a problematic if you can't remember off-hand what the revision is about. As time passes, it becomes easier and easier to forget which revisions you've commented on and why, so the new comments make less sense and require greater context.

The e-mails should look like something like this instead:


User "Platonides" posted a comment on MediaWiki.r70270.

Full URL: http://www.mediawiki.org/wiki/Special:Code/MediaWiki/70270#c13834
Commit summary: * (bug 24563) Entries on Special:WhatLinksHere now have a link to their history

New comment:

I don't see the need for history either. Why history and not edit, for example? If any, I would modify whatlinkshere-links so that those links can be created in MediaWiki namespace.

This way, you can know what the revision was about, so the comments hopefully make more sense.

Having commit summary context should apply to follow-up e-mails and new comment e-mails. I've changed the bug summary to be a bit clearer about this.

r83315 does the followup email message ones...

(In reply to comment #5)

r88316 does the rest

GLHF.

r83316, rather. Thanks, Reedy!

Would it make sense to truncate the commit summary to a certain number of lines or bytes?