Skip to content

feat(email): Email Testing Suite cross-references (t214)#963

Merged
marcusquinn merged 2 commits intomainfrom
feature/t214-email-testing-suite
Feb 10, 2026
Merged

feat(email): Email Testing Suite cross-references (t214)#963
marcusquinn merged 2 commits intomainfrom
feature/t214-email-testing-suite

Conversation

@alex-solovyev
Copy link
Collaborator

@alex-solovyev alex-solovyev commented Feb 10, 2026

Summary

  • Adds Email testing row to the progressive disclosure table in .agents/AGENTS.md, linking to email-design-test.md, email-delivery-test.md, email-health-check.md, and email-test-suite-helper.sh
  • Adds Pre-Send Testing Checklist section and new agent references to .agents/content/distribution/email.md
  • Updates troubleshooting table in .agents/marketing.md with specific email testing tool references (design, delivery, pre-send validation)

Context

Phases 1-3 of t214 (Email Testing Suite) were implemented by a previous worker — this PR completes Phase 4: Cross-references by integrating the new email testing tools into the framework's discovery paths.

Changes

File Change
.agents/AGENTS.md +1 row in progressive disclosure table
.agents/content/distribution/email.md +2 agent links, +pre-send checklist section
.agents/marketing.md +2 troubleshooting rows, updated rendering reference

Testing

  • bash -n syntax check: all 4 email helper scripts pass
  • Preflight linters: only pre-existing issues (no new violations from these markdown changes)

Summary by CodeRabbit

  • Documentation
    • Reorganized email testing docs into an overview plus separate guides for template rendering and delivery validation
    • Added a Pre‑Send Testing Checklist outlining content, design, and delivery validation steps
    • Introduced helper utilities and tooling guidance to automate design checks, cross‑client rendering, and inbox placement/spam analysis

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 10, 2026

Walkthrough

This PR reorganizes email testing documentation: adds an "Email testing" domain entry to the agents index, replaces a single email-testing reference with a three-file suite (overview, design tests, delivery tests), and adds a pre-send testing checklist plus a helper script reference.

Changes

Cohort / File(s) Summary
Agent Routing & Distribution
.agents/AGENTS.md, .agents/content/distribution/email.md
Added "Email testing" domain entry to agent index; expanded email-testing into three docs (email-testing.md, email-design-test.md, email-delivery-test.md) and added Pre-Send Testing Checklist and helper script references.
Marketing Agent Configuration
.agents/marketing.md
Updated template testing references to point to email-design-test.md and email-delivery-test.md; added commands referencing email-test-suite-helper.sh for pre-send validation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related issues

Possibly related PRs

Poem

📧 New tests align the flight,
Docs split neatly, checklist bright,
Design and delivery sing—
A helper script to check the ring,
Pre-send confidence takes flight. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding cross-references for an email testing suite across documentation files in the agents framework.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/t214-email-testing-suite

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
.agents/content/distribution/email.md (1)

266-270: Align the checklist intro with the actual helper scripts.

The checklist headline says to use email-test-suite-helper.sh subcommands, but the steps call out email-health-check-helper.sh, email-design-test-helper.sh, and email-delivery-test-helper.sh. Either update the intro to match the per-script usage, or switch the steps to the suite-helper subcommands.

🔧 Option A: adjust intro to match the listed helpers
-**Pre-Send Testing Checklist** (use `email-test-suite-helper.sh` subcommands):
+**Pre-Send Testing Checklist** (use the dedicated helper scripts):
🔧 Option B: use suite-helper subcommands in the steps
-1. Content checks — subject line, preheader, accessibility, links, images, spam words (`email-health-check-helper.sh`)
-2. Design rendering — cross-client screenshots and compatibility (`email-design-test-helper.sh`)
-3. Delivery testing — inbox placement, spam score, authentication (`email-delivery-test-helper.sh`)
+1. Content checks — subject line, preheader, accessibility, links, images, spam words (`email-test-suite-helper.sh check-content`)
+2. Design rendering — cross-client screenshots and compatibility (`email-test-suite-helper.sh test-design`)
+3. Delivery testing — inbox placement, spam score, authentication (`email-test-suite-helper.sh check-placement`)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

🔍 Code Quality Report

�[0;35m[MONITOR]�[0m Code Review Monitoring Report

�[0;34m[INFO]�[0m Latest Quality Status:
SonarCloud: 0 bugs, 0 vulnerabilities, 36 code smells

�[0;34m[INFO]�[0m Recent monitoring activity:
Tue Feb 10 18:15:25 UTC 2026: Code review monitoring started
Tue Feb 10 18:15:26 UTC 2026: SonarCloud - Bugs: 0, Vulnerabilities: 0, Code Smells: 36

📈 Current Quality Metrics

  • BUGS: 0
  • CODE SMELLS: 36
  • VULNERABILITIES: 0

Generated on: Tue Feb 10 18:15:28 UTC 2026


Generated by AI DevOps Framework Code Review Monitoring

@gemini-code-assist
Copy link

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

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: 2

🤖 Fix all issues with AI agents
In @.agents/AGENTS.md:
- Line 322: The AGENTS.md entry for "Email testing" currently links only to a
subset of email test docs; please search the .agents/ directory for existing
email testing files (e.g., services/email/email-testing.md,
services/email/email-health-check.md, services/email/email-design-testing.md,
services/email/email-delivery-testing.md and helper scripts like
email-test-suite-helper.sh, email-design-test-helper.sh,
email-health-check-helper.sh, email-delivery-test-helper.sh) and either confirm
the subset is intentional or update the table row to include all relevant
documents and helpers so the row references the comprehensive set of resources.

In @.agents/marketing.md:
- Around line 479-481: Update the table entries to use the correct .agents/
prefixed paths (change services/email/email-design-test.md and
services/email/email-delivery-test.md to
.agents/services/email/email-design-test.md and
.agents/services/email/email-delivery-test.md), remove the invalid command
reference `email-test-suite-helper.sh full` and replace it with the correct
supported script flags (e.g. `email-test-suite-helper.sh test-design` or
`email-test-suite-helper.sh check-placement` as appropriate), and consolidate
duplicate guidance by removing overlapping content from
.agents/services/email/email-testing.md and
.agents/content/distribution/email.md so that .agents/marketing.md (AGENTS.md)
remains the single source of truth.

| YouTube | `content/distribution/youtube/` (migrated from root, see content.md) |
| Vision | `tools/vision/overview.md` (decision tree, then `image-generation.md`, `image-understanding.md`, `image-editing.md`) |
| Voice | `tools/voice/speech-to-speech.md`, `voice-helper.sh talk` (voice bridge) |
| Email testing | `services/email/email-design-test.md`, `services/email/email-delivery-test.md`, `services/email/email-health-check.md`, `email-test-suite-helper.sh` |
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# First, check if .agents/ directory exists and explore its structure
echo "=== Exploring .agents/ directory ==="
fd . .agents/ --type f --extension md | head -20

echo -e "\n=== Running rg search for email testing patterns ==="
rg -n --hidden --glob '!.git/**' \
  'Email testing|email-design-test|email-delivery-test|email-health-check|email-test-suite-helper' \
  .agents/ || echo "No matches found"

echo -e "\n=== Checking if AGENTS.md exists and its size ==="
wc -l .agents/AGENTS.md 2>/dev/null || echo ".agents/AGENTS.md not found at expected location"

echo -e "\n=== Checking root level AGENTS.md ==="
if [ -f AGENTS.md ]; then
  wc -l AGENTS.md
  echo "Found at root"
fi

Repository: marcusquinn/aidevops

Length of output: 30257


Verify search for existing email testing instructions per repo guideline.

Before adding new domain entries to AGENTS.md, search existing instructions in .agents/ to ensure completeness and avoid conflicts. The rg search would reveal:

  • services/email/email-testing.md — comprehensive email testing suite
  • services/email/email-health-check.md — DNS authentication and health checks
  • services/email/email-design-testing.md — design rendering tests
  • services/email/email-delivery-testing.md — spam and deliverability tests
  • Multiple helper scripts (email-test-suite-helper.sh, email-design-test-helper.sh, email-health-check-helper.sh, email-delivery-test-helper.sh)

The entry currently links only to a subset of these. Confirm the selection is intentional or update to include all relevant resources.

🤖 Prompt for AI Agents
In @.agents/AGENTS.md at line 322, The AGENTS.md entry for "Email testing"
currently links only to a subset of email test docs; please search the .agents/
directory for existing email testing files (e.g.,
services/email/email-testing.md, services/email/email-health-check.md,
services/email/email-design-testing.md, services/email/email-delivery-testing.md
and helper scripts like email-test-suite-helper.sh, email-design-test-helper.sh,
email-health-check-helper.sh, email-delivery-test-helper.sh) and either confirm
the subset is intentional or update the table row to include all relevant
documents and helpers so the row references the comprehensive set of resources.

Comment on lines 479 to 481
| Template rendering | Use `services/email/email-design-test.md` for cross-client testing |
| Delivery issues | Use `services/email/email-delivery-test.md` for inbox placement and spam scoring |
| Pre-send validation | Run `email-test-suite-helper.sh full` for comprehensive checks |
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# 1) Search for existing/duplicate email testing guidance
rg -n --hidden --glob '!.git/**' \
  'email-design-test|email-delivery-test|email-test-suite-helper|pre-send validation' \
  .agents/

# 2) Confirm referenced files/scripts exist
echo "--- Checking for email-design-test files ---"
fd -a --hidden --glob '*email-*test*.md' .

echo "--- Checking for email-test-suite-helper.sh ---"
fd -a --hidden --glob 'email-test-suite-helper.sh' .

# 3) Verify the specific paths mentioned
echo "--- Direct path check ---"
ls -la services/email/email-design-test.md 2>&1 || echo "NOT FOUND"
ls -la services/email/email-delivery-test.md 2>&1 || echo "NOT FOUND"
ls -la email-test-suite-helper.sh 2>&1 || echo "NOT FOUND"

Repository: marcusquinn/aidevops

Length of output: 19388


🏁 Script executed:

# Check for 'full' command in email-test-suite-helper.sh
rg -A 5 -B 2 'full' .agents/scripts/email-test-suite-helper.sh | head -50

Repository: marcusquinn/aidevops

Length of output: 675


🏁 Script executed:

# Check the main command parsing in email-test-suite-helper.sh
rg -n 'case|full\)' .agents/scripts/email-test-suite-helper.sh | head -30

Repository: marcusquinn/aidevops

Length of output: 91


🏁 Script executed:

# Get the actual command cases in email-test-suite-helper.sh
sed -n '1210,1250p' .agents/scripts/email-test-suite-helper.sh

Repository: marcusquinn/aidevops

Length of output: 1360


🏁 Script executed:

# Search for all top-level commands in email-test-suite-helper.sh
sed -n '1210,1350p' .agents/scripts/email-test-suite-helper.sh | grep -E '^\s+"[^"]+"\)' | head -20

Repository: marcusquinn/aidevops

Length of output: 86


🏁 Script executed:

# Get the full command case statement from email-test-suite-helper.sh
sed -n '1210,1400p' .agents/scripts/email-test-suite-helper.sh

Repository: marcusquinn/aidevops

Length of output: 2714


Fix incomplete paths and remove invalid command reference.

The file paths are missing .agents/ prefix (should be .agents/services/email/email-design-test.md and .agents/services/email/email-delivery-test.md). Additionally, email-test-suite-helper.sh full is not a valid command—the script supports test-design, test-smtp-domain, check-placement, analyze-headers, and others, but not full.

Duplicate email testing guidance exists across .agents/services/email/email-design-test.md, .agents/services/email/email-delivery-test.md, .agents/services/email/email-testing.md, and .agents/content/distribution/email.md, which conflicts with maintaining AGENTS.md as the single source of truth.

🤖 Prompt for AI Agents
In @.agents/marketing.md around lines 479 - 481, Update the table entries to use
the correct .agents/ prefixed paths (change services/email/email-design-test.md
and services/email/email-delivery-test.md to
.agents/services/email/email-design-test.md and
.agents/services/email/email-delivery-test.md), remove the invalid command
reference `email-test-suite-helper.sh full` and replace it with the correct
supported script flags (e.g. `email-test-suite-helper.sh test-design` or
`email-test-suite-helper.sh check-placement` as appropriate), and consolidate
duplicate guidance by removing overlapping content from
.agents/services/email/email-testing.md and
.agents/content/distribution/email.md so that .agents/marketing.md (AGENTS.md)
remains the single source of truth.

@github-actions
Copy link

🔍 Code Quality Report

�[0;35m[MONITOR]�[0m Code Review Monitoring Report

�[0;34m[INFO]�[0m Latest Quality Status:
SonarCloud: 0 bugs, 0 vulnerabilities, 36 code smells

�[0;34m[INFO]�[0m Recent monitoring activity:
Tue Feb 10 18:20:35 UTC 2026: Code review monitoring started
Tue Feb 10 18:20:36 UTC 2026: SonarCloud - Bugs: 0, Vulnerabilities: 0, Code Smells: 36

📈 Current Quality Metrics

  • BUGS: 0
  • CODE SMELLS: 36
  • VULNERABILITIES: 0

Generated on: Tue Feb 10 18:20:38 UTC 2026


Generated by AI DevOps Framework Code Review Monitoring

@sonarqubecloud
Copy link

@marcusquinn marcusquinn merged commit be3a7b2 into main Feb 10, 2026
10 checks passed
@marcusquinn marcusquinn deleted the feature/t214-email-testing-suite branch February 10, 2026 19:02
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.

2 participants