#2164 Improve readabilty of emails
Closed: Won't Fix 2 years ago by wombelix. Opened 7 years ago by mbasti.

Current emails are hard to read, structured form of email may be faster to read.

Proposed format:

  • new issue
    URL: https://pagure.io/pagure/issue/123
Project: pagure
 Author: A User
  Title: #123: Issue and pagure
 Action: Issue opened

Issue description Lorem ipsum sit dolor mit amet
  • comment
    URL: https://pagure.io/pagure/issue/123#comment-123456
Project: pagure
  Title: #123: Issue and pagure
 Action: New comment

`A user` commented:
New comment Lorem ipsum sit dolor mit amet
  • assign issue
    URL: https://pagure.io/pagure/issue/123
Project: pagure
  Title: #123: Issue and pagure
 Action: Assigned to `Human` by ` Project Owner`
  • issue status changed
    URL: https://pagure.io/pagure/issue/123
Project: pagure
  Title: #123: Issue and pagure
 Action: Status changed by `Project owner`
 Status: Closed - Fixed (was Opened)
  • new PR
    URL: https://pagure.io/pagure/pull-request/123
Project: pagure
 Author: A Developer
  Title: #123: Issue and pagure
 Action: Pull-request created

PR description Lorem ipsum sit dolor mit amet
  • PR merged
    URL: https://pagure.io/pagure/pull-request/123
Project: pagure
  Title: #123: Issue and pagure
 Action: Pull-request *merged* by `Project Manager`

Metadata Update from @lslebodn:
- Issue tagged with: IDM

7 years ago

I will be happy to implement any email changes we agreed that's improve readability

Metadata Update from @pingou:
- Issue tagged with: RFE, discussion

7 years ago

+1 for the proposed format

I believe I would prefer a concise format with active voice, e.g for merging a pull request:

Email Subject: PR pagure#123: Issue and pagure

Email body:
"Project Manager" merged pull request pagure#123

https://pagure.io/pagure/pull-request/123

For me the back ticks are irritating in the current mails and the passive voice makes it harder to read. The tabled format that is proposed here seems to contain to much redundant information for my taste.

I would suggest to close it for now and postpone it, there are a lot of things around email notifications that could use some improvements, but in favor of our backlog and the capability to move forward with new pagure releases with the limited amount of active contributors , we should first focus on more urgent topics.

Metadata Update from @wombelix:
- Issue close_status updated to: Won't Fix
- Issue status updated to: Closed (was: Open)

2 years ago

Log in to comment on this ticket.

Metadata