Updated: Comment #N

Problem/Motivation

Consider this case:

  • Original reporter makes some quick/short/not-so-useful report like "Something is wrong".
  • Some other users update the issue summary but don't use the Issue Summary Template standards (lets face it, only a few of us know about it and actually use it).
  • Yet another user comes along and updates the issue summary to comply to the issue summary template. They don't know that the currently edited revision they see is not the actual original report so they instead use the name of the last user to edit the summary for the "Original report by ..." section

Problems with that

:

- The "Original report" section is not what it says in most cases since what you have in place is not the actual *original* report as stated but a/the *previous* to the current one instead. In some cases these are the same, but not always.

- It makes the issue summary needlessly longer. Things are not so bad for short summaries, but it gets really ugly for long ones - times two if the original report is also long.

- Why put users through all the trouble of keeping a revision of the issue summary appended to the end of the summary. This is not necessary because we keep revisions anyways plus we provide the means for people to view them if they want (the "Revisions" link at the top of the summary).

- Why not automate this tedious task instead of asking people to manually do it?

Proposed resolution

1st step would be to actually remove the "Original report by ..." section form the Issue Summary Template standards page. Then perhaps replace it with an automatically generated "Original report" link that points to a diff between the first revision of the issue and the current one. Another idea if we actually need to keep it around in some form (for easier accessibility) would be to somehow embed the first revision in the issue summary or have it be rendered as a collapsed by default "Original report" fieldset just below the issue summary.

Remaining tasks

  1. Remove the "Original report by ..." section form the Issue Summary Template standards page.
  2. Decide if we actually need to keep around some form of that section (link to a diff/collapsed fieldset/what have you.

User interface changes

The Issue Summary Template standards will not contain a "Original report by ..." section.
There might be some automatically generated "Original report" link that will point to a diff between the first revision of the issue and the current one.

API changes

most likely none

Original report by [username]

Irony: this is the part we need to remove ;)

Comments

drumm’s picture

Project: Drupal.org customizations » Documentation
Version: 7.x-3.x-dev »
Component: User interface » Correction/Clarification

I think this might be the right place for this.

saurabh.dhariwal’s picture

Issue summary: View changes