openlibhums / openlibhums/janeway
Email sent confirmation message
Nobody has claimed this yet.
- #3173 by @joemull — closed without merging
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
User Story
This is based on a production editor's feedback.
As an email writer, I am sometimes not 100% sure whether an email was sent, right after I click a button that should have sent it. I see other messages in the bottom right-hand corner like "Review assignment created" or "Typesetter assigned", but these don't tell me about the email. I had the option to skip the email, so I know it's a separate thing. Why would Janeway tell me only about one thing happening, if two things were supposed to happen? It raises just a tiny bit of doubt in the back of my mind.
What if Janeway showed me an email-related message in the bottom-right hand corner, like the other green progress bar things? That would help give me confidence that the emails are going out.
Of course, the email log exists, and if I know it's there, I can go check it. But really that's beside the point. It's about the consistency and thoroughness of the little boxes that appear in the bottom right, allowing me to recognize something I know should be there.
Describe the solution you'd like
Add a message like "Email sent" to the messages framework whenever someone prompts an email to go out. This would be in addition to the message about task creation. The "Email sent" message would need to be consistently implemented across all email interfaces since if folks see it some places but don't see it others, they will think some emails are not being sent.
Additional context
It is tempting to consider things like this as unneeded, given our issue backlog. But they make people feel better, calmer, and more in control when using Janeway, and the value of that for our project cannot be overstated.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by locating the email-sending interfaces and the messages framework, then trace each interface that can prompt an email. Done means every such interface shows an "Email sent" message in addition to its task or action message, with coverage verified across the identified interfaces.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- full-stack
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100