Since issue summary is editable by anyone, and edits are in fact encouraged, we don't want to highlight original issue author on the issue summary itself, for not to tie them to a later state of summary too much. And also for making it more obvious that issue summaries can be edited by anyone.
However, we do want to have a clearly visible historical record of who opened an issue and what was the original state of it. Since comments represent the whole history of changes to the issue, it makes sense to have this record of the starting point as a first comment.
Proposed resolution
When an issue is created, generate an automated comment:
'opened an issue' could also link to the first revision of the issue. This would eliminate the need to keep "Original post by X" section of the issue summary.
Comment should be styled similar to the other automated comments we have e.g. on code commit or test results. There should be no email notification when the comment is created.
Comment | File | Size | Author |
---|
Comments
Comment #1
YesCT CreditAttribution: YesCT commentedSeems like a good idea.
Comment #2
YesCT CreditAttribution: YesCT commentedsome (old dreditor pattern?) credited the issue creator after | in the commit message. Now that we can change the summary, it is not quite as clear who to credit, but seems related to #2230579: [meta] Allow crediting reviewers (and other non-coders) as first-class contributors
Comment #3
YesCT CreditAttribution: YesCT commentedComment #4
YesCT CreditAttribution: YesCT commentedoops.
Comment #5
joshuamiComment #6
YesCT CreditAttribution: YesCT commentedComment #7
YesCT CreditAttribution: YesCT commentedsomething similar got mentioned in #2474609: Not possible to credit people who didn't comment in an issue
that a comment could be automatically made when a committer filled in a field to add people for commit credit purposes...
Comment #8
tvn CreditAttribution: tvn commentedComment #9
drummComment #10
drummSomething to work around with this is that
_node_revision_access()
checks for more than one revision existing. If there is just one revision, the "an issue" link goes to 403. The access check is complex enough, I'm not sure about overriding it.Comment #11
tvn CreditAttribution: tvn commentedWell technically we don't need to have that link right when the issue is created. The original state of issue summary is right there in front of the reader. Now, when the first (non automatic, actual user) comment happens - we get 2nd revision of the issue and the state of issue summary could be different. That's when it is useful to start showing the link. So can we do something at this time?
E.g. initial "webchick created an issue" comment has no links. When issue is first edited, we inject "See original issue" or some such link after 'webchick created an issue'.
Comment #12
drummGreat, I've done that. Dev examples of this are:
https://ci-drupal.redesign.devdrupal.org/node/2508713
https://ci-drupal.redesign.devdrupal.org/node/2508714
Comment #14
tvn CreditAttribution: tvn commentedCan we change 'See original issue' to 'See original summary'? Too many 'issue' in one line, also the issue is the same, summary changes. Otherwise love it!
Comment #16
drummSure, committed that change.
Comment #17
drummComment #19
drummThis will initially double-count the initial comment and the issue posted in the Credit & committing fieldset. The simple way to stop this is to not count the node if it was created after this is deployed to production. Since we don't have that time yet, it will be deployed shortly afterward.
Comment #20
drummI was developing this with comment render caching turned off. That cache needs to be busted when the initial comment is updated.
Comment #22
drummUpdating the comment's changed timestamp is a good way to do that.
Comment #23
drummNow in production, #2545608: Request for 'confirmed' role. This hit another edge case, the confirm button is showing.
Comment #25
drummThat and #19 are ready to deploy.
Comment #26
drummThis is all deployed now.
Comment #27
alexpottImo this needs to be rolled back as it is responsible for losing attribution. This comment will be credited to Chapter Three because the last comment I made on d.o was credited to them. I think if I create a new issue the saved attribution will disappear :(
Comment #28
alexpottAs I expected creating a new issue loses default comment attribution on that issue. I think this should be rolled back as it is new behaviour - #2545886: Provide comment attribution options for the initial automatic issue comment
Comment #29
ciss CreditAttribution: ciss at yousign GmbH commentedThis messes with the reply count, though, as new issues will automatically have 1 reply listed in issue lists. Or is this what #19 referred to?
Comment #30
drumm#19 is only about the Credit & committing fieldset.
Comment #31
markhalliwellIronically, this issue was opened to address not being able to see the "new" underneath user pictures for new issues... which this issue didn't actually do (#2446889-15: Display 'new' indicator next to user picture of new users). Half tempted to re-open, but will defer to creating a new issue if that is more desirable.
Comment #32
drummLet's do a followup issue. A mockup would be appreciated - do we keep some of the system-message-like styling, or none of it?
Comment #33
markhalliwellOk, I created #2552835: Improve automatically generated issue creation comment. I don't think a mockup is necessary per se. The comment should just be from the user who originally opened the issue. The system message user does not have the picture or the new/confirm meta information a normal user comment would have (nor would it make sense to include that for the system message I think).
Comment #34
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedCan we change "created an issue" to "reported this issue" ?
Comment #35
markhalliwellActually this entire issue should be reverted once #2553355: Add "Reported by" and "Created" date to the sidebar on issue pages is in. There is no need to have duplicate information. It also didn't address the original point of this issue.
Comment #36
joshuamiI still think we need that first comment as mentioned in #2553355: Add "Reported by" and "Created" date to the sidebar on issue pages. It really does give us a good way to quickly confirm a valid user and a way to trigger a comment for issue credits with a small change.
Comment #37
markhalliwellNo. That commit list can easily be modified to simply include the OP (issue author/reporter) as an option. We don't have to "rely" on a comment to add this user to the generated list.
Comment #38
drummExcept not volunteer/organization/customer. Those are fields on comments. While those aren't exposed yet, the initial comment does get us closer to being able to fill out the whole credit form when creating an issue.
Comment #39
hestenetFWIW the automatically generated comment does also add a quick link to the original issue summary (which IS the actual voice of the reporter) and does so in chronological context. I think that helps preserve the original reporter's voice (which some here find valuable) in a way that's compatible with removing the authored by line so that the summary itself is more easily understood to be collaborative.
Comment #40
markhalliwellIf the user decides to engage with the issue, they would have the opportunity to change this in the comment yes?
When a user initially creates an issue, they are modifying the issue summary... not a comment. I don't see how determining the "volunteer/organization/customer" status upon issue creation would ever be possible unless the initially issue summary was also the initial comment. That just sounds like a recipe for disaster and confusion.
Comment #41
joshuamiIncluding the issue reporter in the credit UI without a comment is not as easy as it would seem. The data model associates credits to comments. To add issue credits without a comment of some sort is going to require quite a bit of rework. To accommodate crediting users that are not involved in the issue thread but contributed (such as a face-to-face conversation at a sprint) will require adding a system comment as well.
@drumm gave this a lot of thought when we were working out a model. Comments were the best way to trace the history of how much participation a person had in the issue.
Comment #42
markhalliwellThat could easily be added as a link post rendering of the issue summary itself. It is static information and would never change, it doesn't need to be a comment.
Comment #43
tim.plunkettThe "See original summary." part is awesome. I'd love to keep this feature just for that.
Comment #44
tvn CreditAttribution: tvn commentedI do not think this should be reverted even after adding metadata to the sidebar.
Comment stream represents a history of all changes to the issue / issue summary. Initial state of the summary is a first step and makes total sense to have it as a part of the stream. In addition to that we can use it to make the original reporter a 'proper' participant of the issue as all the commenters by displaying their userpic in that comment, along with the new label and confirm button, their credit attribution, and being able to award them credit even if they never commented on the issue.
To have less clutter we could consider displaying the 'new' label only on this comment and not display it in the sidebar metadata. The pattern for displaying new user status is label below userpic (with the confirm button below if they aren't confirmed yet). Proposed way to display it in the sidebar looks more like new content (e.g. new comment or issue) pattern.
Comment #45
kattekrab CreditAttribution: kattekrab at Creative Contingencies commentedCan we change "created an issue" to "reported this issue" ?
Comment #46
markhalliwell@kattekrab, I agree.
I've re-opened #2552835: Improve automatically generated issue creation comment to address follow-ups to this issue. Marking this one as fixed.
Comment #48
YesCT CreditAttribution: YesCT commented#2580851: no indicator for credit attribution for comments that are automatically generated when an issue is created
we have a bug. attribution for automatic first comment... should be able to be set when opening the issue, or default to nothing.