Skip to content

chore: simplify comment template#95

Merged
coriolinus merged 2 commits into
hackathon-2026from
prgn/chore/simplify-comment-template
Jun 18, 2026
Merged

chore: simplify comment template#95
coriolinus merged 2 commits into
hackathon-2026from
prgn/chore/simplify-comment-template

Conversation

@coriolinus

Copy link
Copy Markdown

PR Submission Checklist for internal contributors

  • The PR Title

    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³
  • The PR Description

    • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Issues

Briefly describe the issue you have solved or implemented with this pull request. If the PR contains multiple issues, use a bullet list.

Causes (Optional)

Briefly describe the causes behind the issues. This could be helpful to understand the adopted solutions behind some nasty bugs or complex issues.

Solutions

Briefly describe the solutions you have implemented for the issues explained above.

Dependencies (Optional)

If there are some other pull requests related to this one (e.g. new releases of frameworks), specify them here.

Needs releases with:

  • GitHub link to other pull request

Testing

Test Coverage (Optional)

  • I have added automated test to this contribution

How to Test

Briefly describe how this change was tested and if applicable the exact steps taken to verify that it works as expected.

Notes (Optional)

Specify here any other facts that you think are important for this issue.

Attachments (Optional)

Attachments like images, videos, etc. (drag and drop in the text box)


PR Post Submission Checklist for internal contributors (Optional)

  • Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

  • If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

References
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

@coriolinus coriolinus requested a review from a team as a code owner June 18, 2026 11:44

[comment]({{comment.htmlUrl}})
{{{comment.body}}} No newline at end of file

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing newline

@claude

claude Bot commented Jun 18, 2026

Copy link
Copy Markdown

Review: chore: simplify comment template

Thanks for the cleanup — the new layout is a genuine UX improvement. Inlining the link into the author line (**@user** [commented](url):) is more compact and readable than the previous trailing [comment](url) + em-dash footer. Nothing blocking; a few small observations.

Minor issues

  • Missing trailing newline. The diff shows No newline at end of file. Every sibling template in src/main/resources/templates/en/ ends with a newline, so this is a small consistency regression. Worth re-adding the final newline.

  • Style now diverges from sibling templates. This template drops the **[{{repository.fullName}}]** prefix and the [comment](url) + em-dash footer, but the closely-related ones still use the old style: commit_comment.created.template, issue_comment.created.template, and pull_request_review.submitted.template. If this is the intended new house style, consider applying it to those too so notifications look uniform — otherwise users see two different formats for very similar events. If it is deliberately scoped to just this template, that is fine, just flagging it.

  • Dropping repository.fullName removes the repo context. For a channel that aggregates events from multiple repositories, the reader can no longer tell at a glance which repo a review comment belongs to (the comment link still points there, but it is not visible). Worth a conscious decision rather than an incidental loss from the simplification.

Notes

  • The unescaped {{{comment.body}}} triple-stache is correctly preserved, so markdown in the comment body still renders. Good.
  • No behavioral concerns: TemplateHandler just compiles and executes the Mustache template, so this is a pure presentation change with no security or performance impact.

Test coverage

There do not appear to be any tests exercising the templates (no template render tests under src/test). Not something this PR needs to fix, but a small snapshot/render test per template would catch malformed Mustache and accidental formatting regressions like the missing newline above.


Automated review — feedback is advisory; use your judgement.


[comment]({{comment.htmlUrl}})
{{{comment.body}}} No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You miss newline at eof

@coriolinus coriolinus merged commit 4823230 into hackathon-2026 Jun 18, 2026
4 of 5 checks passed
@coriolinus coriolinus deleted the prgn/chore/simplify-comment-template branch June 18, 2026 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants