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

Enhancement: Update Developer Inquiry Email #4387

Merged
merged 1 commit into from
Feb 7, 2025
Merged

Conversation

Baalmart
Copy link
Contributor

@Baalmart Baalmart commented Feb 7, 2025

Description

This PR updates the email content sent to developers who inquire about contributing to AirQo. It adds a link to the Google form for joining the open-source community and removes the contact information for the Software Engineering Lead

Changes Made

  • Added Google Form Link: A link to the Google form for open-source contributions has been added to the email content.
  • Removed Software Engineering Lead Contact: The email address and contact details for the Software Engineering Lead have been removed. (Provide a brief reason if possible, e.g., "as per request," or "to streamline the process.")

Testing

  • Tested locally
  • Tested against staging environment
  • Relevant tests passed: [List test names]

Affected Services

  • Which services were modified:
    • Auth Service.

Endpoints Ready for Testing

  • New endpoints ready for testing:
    • Post Inquiry

API Documentation Updated?

  • Yes, API documentation was updated
  • No, API documentation does not need updating

Summary by CodeRabbit

  • New Features
    • Notifications now dynamically indicate whether a device has been recalled or deployed. This enhancement provides clearer, context-specific messaging to users.

Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

📝 Walkthrough

Walkthrough

The update modifies the field_activity method in the email messages utility by adding an activityType parameter with a default value of "recall". The method now conditionally generates the email message content based on whether the activityType indicates a recall or a deployment. The core structure of the method remains unchanged while its logic for message generation becomes dynamic.

Changes

File(s) Change Summary
src/auth-service/utils/common/email.msgs.js Updated field_activity method: added a new parameter activityType (default: "recall") and changed the action message to be conditional based on activityType.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant EmailMsgs
    Caller->>EmailMsgs: Call field_activity(parameters, activityType)
    EmailMsgs->>EmailMsgs: Check activityType value
    alt activityType == "recall"
        EmailMsgs-->>Caller: Return "recall" email message
    else other value
        EmailMsgs-->>Caller: Return "deployment" email message
    end
Loading

Possibly related PRs

Poem

In lines of code a new twist unfurls,
A parameter added to guide our worlds.
With "recall" or "deploy" the email takes flight,
Messages now dance in dynamic light.
Code sings its tune—clear and bright! 😊

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Feb 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.21%. Comparing base (f6d38c2) to head (182d524).
Report is 9 commits behind head on staging.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           staging    #4387   +/-   ##
========================================
  Coverage    11.21%   11.21%           
========================================
  Files          156      156           
  Lines        17968    17968           
  Branches       388      388           
========================================
  Hits          2015     2015           
  Misses       15951    15951           
  Partials         2        2           
Files with missing lines Coverage Δ
src/auth-service/utils/common/email.msgs.js 3.03% <ø> (ø)

Copy link
Contributor

@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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/auth-service/utils/common/email.msgs.js (1)

164-164: Consider moving the Google form URL to constants.

While the form link addition is good, hardcoding URLs can make maintenance difficult. Consider moving this URL to the constants file for better maintainability.

-                                    <p>To contribute to our open-source community as a software engineer, please fill out this <a href="https://docs.google.com/forms/d/e/1FAIpQLSc7xixPoIo65pe6mlbNVB8jM5F4ZKCz87SmQTY412XbsqWrLQ/viewform?usp=dialog">form</a>.</p>
+                                    <p>To contribute to our open-source community as a software engineer, please fill out this <a href="${constants.OPENSOURCE_FORM}">form</a>.</p>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d019703 and 182d524.

📒 Files selected for processing (1)
  • src/auth-service/utils/common/email.msgs.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build-push-deploy-auth-service
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
src/auth-service/utils/common/email.msgs.js (1)

438-482: LGTM! Well-structured enhancement to the field activity notification.

The changes effectively implement dynamic messaging based on activity type while maintaining backward compatibility with the default "recall" value. The code is clean and well-organized.

Copy link
Contributor

github-actions bot commented Feb 7, 2025

Auth-service changes in this PR available for preview here

@Baalmart Baalmart merged commit 3f366c4 into staging Feb 7, 2025
52 checks passed
@Baalmart Baalmart deleted the hf-inquiry-emails branch February 7, 2025 07:24
@Baalmart Baalmart mentioned this pull request Feb 7, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant