openlibhums / openlibhums/janeway
Move journal name appended to emails to templates
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Describe the bug
The journal name is appended to transactional emails right before they go out, rather than as part of the editable email templates.
This means:
- It is not visible when composing an email, so the user might think they need to put the journal name in their email signature or in the body of the email, which would then be redundant information
- It cannot be changed by the user in edge cases not anticipated by us
- It makes testing emails a bit more difficult
This is a small thing, almost insignificant in itself, but for consistency with the rest of the email writing interface, it merits a change. In general we want to allow users to anticipate system behaviour and have reasonable control over it--especially when it is an email sent in their name. So, eventually, we want to make this part of the email template.
In addition to removing the line in notify_email above, this would involve a migration that adds {{ journal.name }} to templates as appropriate.
Janeway version
1.4.2
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
Start with src/utils/notify_plugins/notify_email.py at the linked line, then identify the transactional email templates that currently receive the appended journal name. Review the migration patterns used for template changes and update the relevant templates so the journal name is editable there; done means the runtime append is removed and those templates include {{ journal.name }}.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100