datatracker icon indicating copy to clipboard operation
datatracker copied to clipboard

Add draft title in beginning of review email message

Open peterthomassen opened this issue 1 year ago • 5 comments

Description

Review email messages usually begin with lines like

Reviewer: [...]
Review result: [...]

Additionally, the draft identifier is mentioned in subject, but it is often difficult to recall the correct draft immediately. For example, the list linked above recently had reviews with subjects

  • Dnsdir telechat review of draft-ietf-dnsop-rfc8109bis-06
  • Dnsdir telechat review of draft-ietf-dnsop-rfc7958bis-04

... which is not very telling.

Request: Please add another line at the beginning of the message, quoting the actual draft title.

Code of Conduct

peterthomassen avatar Aug 28 '24 12:08 peterthomassen

First, I think it's a great idea. There is a lot of these reviews and personally I read only handful, and identifying the relevant bits takes more time than reading the parts I'm interested in.

Personally I would go even further append title to the end of Subject line because more often than not I will not even open the body - assuming I can identify the document is not relevant for me.

I.e. it would turn a Subject we have today:

Dnsdir telechat review of draft-ietf-dnsop-rfc7958bis-04

into

Dnsdir telechat review of draft-ietf-dnsop-rfc7958bis-04: DNSSEC Trust Anchor Publication for the Root Zone

Obviously the subject can become very long. I don't think it's a problem in 2024, but if it was a problem some middle ground could be found by cutting it at an arbitrary length. Say 80 chars:

Dnsdir telechat review of draft-ietf-dnsop-rfc7958bis-04: DNSSEC Trust Anchor...

Do the labels mean that a PR would be accepted for one of these approaches?

pspacek avatar Aug 30 '24 11:08 pspacek

Do the labels mean that a PR would be accepted for one of these approaches?

PRs are always welcome, but the labels (particularly the "accepted" label) are a clue that they're likely to be merged rather than met with a "won't fix" for some reason.

jennifer-richards avatar Aug 30 '24 16:08 jennifer-richards

there have been multiple threads about the subject content with the review teams, and the current compromise is the result. Putting the title in the subject (in various places) was discussed, and arguments against were made, showing how it would break or at least impair several reviewer's workflows.

rjsparks avatar Sep 03 '24 13:09 rjsparks

Heh, I was about to submit PR which adds the title to Subject only. What about adding the title to the body text? Would that break workflow for someone? (Insert appropriate XKCD reference here :-))

pspacek avatar Sep 03 '24 14:09 pspacek

Because reviewers can mutate the form of that body text (and it varies so much between teams), the chance of automation being built that would break on that change is very low.

rjsparks avatar Sep 03 '24 15:09 rjsparks