apache / lucene-jira-archive

Jira archive for Apache Lucene
https://lucene.apache.org/
2 stars 6 forks source link

Consider removing "Legacy Jira: by" prefix from comments #122

Closed vlsi closed 2 years ago

vlsi commented 2 years ago

"Legacy Jira: by" does not seem to add much value, however, it makes it harder to read the comments (see https://github.com/mocobeta/forks-migration-test-2/issues/10595#issuecomment-1205993910)

I understand you have to use "bot account" for the import, however, it looks like you could just start the comment with the real username. "legacy jira: by" is excessive.

mocobeta commented 2 years ago

I'm fine with removing "Legacy Jira" from the header - what do you think @mikemccand?

mikemccand commented 2 years ago

I'm OK with shortening it somehow if we can, but I think the sentiment must remain -- we need to convey this was a migrated comment to future people who didn't even know we did this issue migration. Maybe "Prior Jira: "? "Migrated Jira: "?

We could remove the by prefix after the : at least?

vlsi commented 2 years ago

I think the sentiment must remain -- we need to convey this was a migrated comment to future people

I just thought the comment date (and the fact it would be created by asfgit account) would be just enough to tell the comment was migrated.

mocobeta commented 2 years ago

we need to convey this was a migrated comment to future people who didn't even know we did this issue migration. Maybe "Prior Jira: "? "Migrated Jira: "?

I'm also inclined to keep suggesting "Jira" (the original source) in the issue descriptions/comments.

vlsi commented 2 years ago

How about changing from

[Legacy Jira: by Yuting Gan (@ Yuti-G) on Jul 10 2022]

to

Yuting Gan (@ Yuti-G) (migrated from JIRA)

?

The date is already present in GitHub UI, so duplicating it does not add much.

mikemccand commented 2 years ago

The date is already present in GitHub UI, so duplicating it does not add much.

+1, I like that. It can just say "migrated from Jira" (no need to say comment/description)?

mocobeta commented 2 years ago

OK makes sense to me, I'll change the header like this.

Yuting Gan (@ Yuti-G) (migrated from JIRA)

mocobeta commented 2 years ago

Addressed in #128.

mocobeta commented 2 years ago

128 was merged - I'm closing this. Thanks @vlsi and @mikemccand for your suggestions.