Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Email Digest #2103

Open
gmeben opened this issue Apr 3, 2024 · 3 comments
Open

Email Digest #2103

gmeben opened this issue Apr 3, 2024 · 3 comments
Labels
🕸️ backend Related to the Backend PHP API 💍 feature New feature or request ❓ question Further information is requested

Comments

@gmeben
Copy link
Contributor

gmeben commented Apr 3, 2024

There has been a desire for a summary of submission activity sent to users via email, called an "email digest." Currently, there's no such thing in Pilcrow.

Add email digests to Pilcrow. Users associated with a submission should receive email digests at a specified time interval whenever a submission is updated. They should not be sent if there has been no new activity. This kind of activity should be included:

  • status changes
  • newly added inline comments
  • newly added overall comments

Users should be able to access a settings page where they can set their preferences of what to be included in email digests and how frequently they are sent.

Review Checklist

  • Necessary backend unit testing has been added
  • Necessary frontend unit testing has been added
  • Necessary integration testing has been added
  • Documentation has been updated to reflect new changes

Accessibility Checklist

  • No new color contrast issues are introduced
  • Changed text has a font size of at least 16px
  • Changed text uses plain language
@gmeben gmeben added 🧹 needs-refinement Issues that need more detail in order to be ready for work to commence 💍 feature New feature or request 🕸️ backend Related to the Backend PHP API ❓ question Further information is requested and removed 🧹 needs-refinement Issues that need more detail in order to be ready for work to commence labels Apr 3, 2024
@gmeben
Copy link
Contributor Author

gmeben commented Apr 3, 2024

Question: What other kinds of activity should this email digest capture?

@sattler9
Copy link
Contributor

sattler9 commented Apr 3, 2024

Hey team! Please add your planning poker estimate with Zenhub @gmeben @vilagshe @wreality

@gmeben
Copy link
Contributor Author

gmeben commented Apr 3, 2024

Answer: After discussing, we determined that these digests could also include assignments of reviewers. There may be more data that publications may want.

There may also be different kinds of digests depending upon user role. For example, coordinators may need/want to know all the reviews that are assigned to reviewers of reviews they are coordinating, which may not be useful information for submitters.

We'll settle for now to include what's described (status change, comments) and extend later as needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕸️ backend Related to the Backend PHP API 💍 feature New feature or request ❓ question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants