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

Modifications to the automatic email sent to new members. #469

Open
wants to merge 21 commits into
base: master
Choose a base branch
from

Conversation

nperozzi
Copy link

@nperozzi nperozzi commented Feb 17, 2024

Hi,
I am submitting a new version of the automatic email sent to new members when their membership is approved.
The email is a complement to the Member Introduction Guide. It expands on some topics, repeats others, and complements with links to further info.

Summary by CodeRabbit

  • Refactor
    • Updated VS Code settings for improved import organization.
  • New Features
    • Enriched member welcome email template with new sections and content.
  • Documentation
    • Enhanced clarity and presentation of member details and rules in welcome emails.
  • Style
    • Implemented styling for text boxes in the member welcome email template.

Copy link

coderabbitai bot commented Feb 17, 2024

Walkthrough

The updates encompass two main areas: a refinement in the VS Code settings to enhance import organization by switching from a boolean to a more descriptive string value, and comprehensive enhancements to the new_member.body.html template. These enhancements include the incorporation of meta and style elements, content restructuring and expansion in both Swedish and English, and detailed updates aimed at clarifying member information, rules, and responsibilities, alongside formatting improvements.

Changes

File Summary of Changes
.vscode/settings.json Changed source.organizeImports from true to "explicit" to refine import organization.
api/src/.../new_member.body.html Added meta charset and style block; restructured and rephrased content; introduced new sections; updated member information presentation; clarified rules, responsibilities, and resources; made formatting improvements.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e3e1757 and 2232c6e.
Files selected for processing (2)
  • .vscode/settings.json (1 hunks)
  • api/src/templates/new_member.body.html (1 hunks)
Additional comments: 2
.vscode/settings.json (1)
  • 6-6: The modification of source.organizeImports from a boolean to a string value "explicit" is unconventional. VS Code settings for organizing imports typically expect a boolean value (true or false). Please verify that "explicit" is a supported value and achieves the intended effect. If it's not supported, consider reverting to a boolean or further clarifying the intention behind this change.
api/src/templates/new_member.body.html (1)
  • 3-3: Adding <meta charset="UTF-8"> is a good practice to ensure correct character display across various email clients and devices. This change enhances the email's compatibility and accessibility.

api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Show resolved Hide resolved
api/src/templates/new_member.body.html Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2232c6e and 1fb0f08.
Files selected for processing (1)
  • api/src/templates/new_member.body.html (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • api/src/templates/new_member.body.html

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1fb0f08 and b79a0f4.
Files selected for processing (1)
  • api/src/templates/new_member.body.html (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • api/src/templates/new_member.body.html

.vscode/settings.json Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b79a0f4 and 7ec153f.
Files selected for processing (1)
  • api/src/templates/new_member.body.html (1 hunks)
Additional comments: 7
api/src/templates/new_member.body.html (7)
  • 3-3: The inclusion of <meta charset="UTF-8"> is a good practice for ensuring that the email content is correctly displayed across different email clients and devices, especially when dealing with special characters or languages other than English.
  • 4-8: The addition of the .text-box class styling directly within the HTML template might be suitable for email templates due to the compatibility issues with external CSS in many email clients. However, it's important to keep the styling minimal and ensure it's widely supported across different email clients to maintain the visual appeal and readability of the email content.
  • 14-15: The "About language" section is a thoughtful addition, providing clarity on the language policy and encouraging inclusivity by welcoming the use of English alongside Swedish. This is particularly important in a diverse community like Stockholm Makerspace, ensuring all members feel included regardless of their primary language.
  • 19-22: The introduction in Swedish is warm and welcoming, setting a positive tone for the rest of the email. It's important to maintain this tone throughout the email to ensure new members feel genuinely welcomed and excited about their membership.
  • 24-27: Presenting member information right at the beginning is a good practice as it personalizes the email and confirms the details that the makerspace has on file for the member. It's crucial to ensure that the template variables (e.g., {{member.firstname}}) are correctly populated from the database to avoid sending out emails with missing or incorrect information.
  • 57-62: The section on being considerate towards other members by cleaning up and using equipment correctly is essential for a shared space. Repeating "Den medlemmen kan vara du" (That member could be you) is a playful way to emphasize personal responsibility, but it's important to ensure that the tone aligns with the overall message and doesn't become repetitive or lose its impact.
  • 146-151: The "Expected conduct at the space" section in English mirrors the Swedish section's emphasis on consideration and responsibility. The repetition of "That member could be you" in English maintains consistency across language versions and reinforces the message of personal responsibility in a shared community space.

api/src/templates/new_member.body.html Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7ec153f and 176c215.
Files selected for processing (1)
  • api/src/templates/new_member.body.html (1 hunks)
Additional comments: 4
api/src/templates/new_member.body.html (4)
  • 3-3: Adding a <meta charset="UTF-8"> declaration is a good practice to ensure proper display of email content across different email clients and systems.
  • 14-15: The introduction of a section about language preferences and availability of resources in both Swedish and English is thoughtful and inclusive. It helps set clear expectations for new members regarding language use within the community.
  • 19-100: The Swedish section has been significantly restructured and updated with clear and concise information about member details, getting started steps, conduct guidelines, and useful links. Ensure that all links are correct and accessible, and consider the feedback from previous reviews regarding the necessity and clarity of certain sections.
  • 107-189: Similar to the Swedish section, the English section has been updated with comprehensive information for new members. It's important to ensure consistency between the Swedish and English sections in terms of content and to address any previous feedback relevant to both language versions.

@HalfVoxel
Copy link
Contributor

Would you mind sending a test email to us (ideally also the previous email as a comparison)? It's a bit hard to get a feeling for the impression by just reading the HTML code.

@emanuelen5
Copy link
Member

emanuelen5 commented Feb 29, 2024 via email

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 176c215 and 1355ddf.
Files selected for processing (1)
  • api/src/templates/new_member.body.html (1 hunks)
Additional comments: 1
api/src/templates/new_member.body.html (1)
  • 14-15: The introduction of the "About language" section is a thoughtful addition, providing clarity on the language policy and encouraging inclusivity. This preemptively addresses potential concerns from non-Swedish speaking members and guides them on how to seek help, fostering a welcoming environment.

api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
api/src/templates/new_member.body.html Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1355ddf and c4efc9c.
Files selected for processing (1)
  • api/src/templates/new_member.body.html (1 hunks)
Additional comments: 4
api/src/templates/new_member.body.html (4)
  • 14-15: The introduction of the "About language" section is a thoughtful addition, providing clarity on the language policy at Stockholm Makerspace. This preemptively addresses potential concerns from non-Swedish speaking members and encourages inclusivity.
  • 37-51: The "Getting Started" section is well-structured, providing clear and actionable steps for new members. It effectively uses external links to guide members to essential resources. Ensure all links are up-to-date and accessible to prevent any confusion or frustration for new members.
  • 133-136: Regarding the use of emojis, ensure they are universally supported across different email clients and devices to maintain the intended visual appeal and tone of the message. Testing the email across various platforms can help identify any potential rendering issues.
  • 166-172: The "Order, cleaning, and maintenance" section in the English block mirrors its Swedish counterpart effectively, maintaining consistency in the information provided to all members regardless of their preferred language. This consistency is key to ensuring all members have equal access to important information.

api/src/templates/new_member.body.html Show resolved Hide resolved
api/src/templates/new_member.body.html Show resolved Hide resolved
api/src/templates/new_member.body.html Show resolved Hide resolved
@nperozzi
Copy link
Author

nperozzi commented Mar 2, 2024

Hi guys! 🖐
I believe I fixed all the comments. What is the next step of this process?

Other related topics:

  1. The trigger for this email should be when the Intro Course host presses "Save" or "Save and send Accessy" buttons after people sign the makerspace agreement. Currently, the automation (not sure how we call the py script that does this), sends this email when the first payment is confirmed, which happens before the Intro Course.
  2. We still need an email to be sent when people make their first payment. As per discussions during the last project evening, this email should be short and include just these points (or something like it):
  • "Welcome to the makerspace! Your first payment has been confirmed"
  • Next step: Register for an Intro course where you will get information and you will sign the makerspece agreement. This is the link to the registration in Calendly.
  • Join Slack: This is the link to Slack.

</p>
{% block swedish %}
<div class="text-box">
<h3 > About language</h3>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<h3 > About language</h3>
<h3 >About language</h3>

{% block swedish %}
<div class="text-box">
<h3 > About language</h3>
<p>The primary language on Stockholm Makerspace is Swedish, but you are very welcome to use English as well. Newsletters and important announcements as well as our courses are as a rule available in English. If you need help to translate something from Swedish to English, don’t hesitate to ask other members or post about it on Slack. An English version of this email is available further down.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like this is a very long paragraph, especially since it's the first thing in the email.

Maybe shortening it to this? (also putting the most important thing in the beginning).

{% block swedish %}
<div class="text-box">
<h3 > About language</h3>
<p>The primary language on Stockholm Makerspace is Swedish, but you are very welcome to use English as well. Newsletters and important announcements as well as our courses are as a rule available in English. If you need help to translate something from Swedish to English, don’t hesitate to ask other members or post about it on Slack. An English version of this email is available further down.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<p>The primary language on Stockholm Makerspace is Swedish, but you are very welcome to use English as well. Newsletters and important announcements as well as our courses are as a rule available in English. If you need help to translate something from Swedish to English, don’t hesitate to ask other members or post about it on Slack. An English version of this email is available further down.</p>
<p>An English version of this email is available further down. The primary language at Stockholm Makerspace is Swedish, but important announcements as well as our courses are generally available in both Swedish and English.</p>

<li>Städa alltid upp efter dig. Glöm inte att fler medlemmar kommer senare för att använda samma ytor och maskiner. Den medlemmen kan vara du.</li>
<li>Se till att använda utrustning och lokaler på ett korrekt sätt. Om utrustning används på felaktigt vis kan du skada utrustningen och göra den omöjlig att använda för fler medlemmar. Den medlemmen kan vara du.</li>
<li>Informera om något är trasigt, försvunnet eller om det behöver fyllas på med något. Saker går sönder ibland, det är sånt som händer. Om du inte kan laga det själv så skriv på Slack. Om du inte gör det kommer utrustningen förbli trasig när fler medlemmar vill använda den. Den medlemmen kan vara du.</li>
<li>Ta inte utrustning med dig. Om du tar hem saker är den inte tillgänglig för fler medlemmar. Den medlemmen kan vara du.</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<li>Ta inte utrustning med dig. Om du tar hem saker är den inte tillgänglig för fler medlemmar. Den medlemmen kan vara du.</li>
<li>Ta inte utrustning med dig. Utrustning ska aldrig lämna spacet.</li>

api/src/templates/new_member.body.html Show resolved Hide resolved
<li>Pågående projekt, material och förvaringslådor kräver alla en förvaringsetikett. Du kan skriva ut dessa i våra Memberbooth. Lär mer om dem på <a href="https://wiki.makerspace.se/Memberbooth">Memberbooth wikisida</a>.</li>
<li>Alla medlemmar har rätt att ha en förvaringslåda på makerspacet. Du hittar information om dessa på <a href="https://wiki.makerspace.se/Medlemsf%C3%B6rvaring">wikisidan för medlemsförvaring</a>.</li>
<li>Om du ser en full soptunna så töm soporna, släng påsen i soprummet och sätt in en ny påse. Här finns instruktioner hur du hittar det: <a href="https://wiki.makerspace.se/St%C3%A4drutiner">Städrutiner</a>.</li>
<li>Kom ihåg: du får inte förvara Li-ion-batterier i makerspace. Om de används felaktigt utgör de en brandrisk.</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<li>Kom ihåg: du får inte förvara Li-ion-batterier i makerspace. Om de används felaktigt utgör de en brandrisk.</li>
<li>Du får inte förvara Li-ion-celler i makerspace då dessa utgör en brandrisk.</li>

Nothing to remember if this is the first time people are hearing about this (likely).

<ul>
<li>Pågående projekt, material och förvaringslådor kräver alla en förvaringsetikett. Du kan skriva ut dessa i våra Memberbooth. Lär mer om dem på <a href="https://wiki.makerspace.se/Memberbooth">Memberbooth wikisida</a>.</li>
<li>Alla medlemmar har rätt att ha en förvaringslåda på makerspacet. Du hittar information om dessa på <a href="https://wiki.makerspace.se/Medlemsf%C3%B6rvaring">wikisidan för medlemsförvaring</a>.</li>
<li>Om du ser en full soptunna så töm soporna, släng påsen i soprummet och sätt in en ny påse. Här finns instruktioner hur du hittar det: <a href="https://wiki.makerspace.se/St%C3%A4drutiner">Städrutiner</a>.</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<li>Om du ser en full soptunna så töm soporna, släng påsen i soprummet och sätt in en ny påse. Här finns instruktioner hur du hittar det: <a href="https://wiki.makerspace.se/St%C3%A4drutiner">Städrutiner</a>.</li>
<li>Om du ser en full soptunna så töm soporna, släng påsen i soprummet och sätt in en ny påse. <a href="https://wiki.makerspace.se/St%C3%A4drutiner">Här finns instruktioner om hur du gör</a>.</li>

Shortened by making the link part of the text.

@HalfVoxel
Copy link
Contributor

HalfVoxel commented May 3, 2024

If it would be possible for you to send a test email to all reviewers, that would be great. It would be great if this could be sent to our actual email addresses, to get a feel for how it flows in an actual email client.

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