Skip to content

Add review-sdk-changelog skill and slash command#88

Merged
mallikarjun-dhulange merged 1 commit into
mainfrom
add-review-sdk-changelog-skill
May 15, 2026
Merged

Add review-sdk-changelog skill and slash command#88
mallikarjun-dhulange merged 1 commit into
mainfrom
add-review-sdk-changelog-skill

Conversation

@umangmoe
Copy link
Copy Markdown
Collaborator

Summary

  • Adds .claude/skills/review-sdk-changelog/SKILL.md — a Claude Code skill for reviewing Android and iOS SDK changelog files from the perspective of a junior developer.
  • Adds .claude/commands/review-sdk-changelog.md — the /review-sdk-changelog <path> slash command entry point.

What the skill covers

The skill is structured around the four questions a junior developer asks when reading a changelog:

  1. Do I need to upgrade?
  2. Will this break my code?
  3. What do I need to do?
  4. Where do I learn more?

11 checklist sections:

  • Upgrade decision clarity — internal-only entries must say "No developer action required"; deprecations need removal version, timeline, and migration link in a <Warning> callout
  • Fix descriptions — observable symptom required, not just internal cause; conditions and affected OEMs named where known
  • "What's New" completeness — doc links required, no Zendesk URLs, repeated module entries consolidated
  • Badge/tag consistency — Android: no mixed <span> / <Badge> implementations, consistent hex colours; iOS: uniform <Badge> usage across all 2025+ entries
  • Heading hierarchy — Android: H1 dates, H2 modules, H3 Release Summary, no drift to H2/H4; iOS: consistent <Card> or bare heading for Release Summary, no <div> wrappers
  • Version number accuracy — BOM cell vs link href must match, 4.404.4.0, consistent zero-padding
  • Module name consistency — table of all observed variants (RichNotification vs Rich Notification, InApp vs InApps, etc.)
  • Links — no Zendesk URLs, no absolute https://www.moengage.com/docs/ URLs, kebab-case paths only
  • New feature completeness — prerequisites stated, "no code changes required" explicit when applicable
  • Date format — ordinal long form (6th May 2026), correct ordinal suffixes
  • Writing quality — detailed section with before/after examples for every pattern

Writing quality section covers:

  • Sentence structure: complete sentences, start with the change not "MoEngage has...", correct tense per category
  • Passive voice: when to rewrite and when it's acceptable, with examples from actual entries
  • Vague language: six named patterns ("certain OEMs", "some constants", "Updates to support X", "Internal improvements", etc.) each with rewrite guidance
  • Link anchor text: "refer here" and "refer to the doc" patterns
  • API/method name formatting (backticks)
  • Three entry-type templates with good/bad examples: What's New, Fixes, Deprecations
  • Deprecation-specific: "We recommend migrating" → "Migrate before upgrading to X.0.0"

Common patterns table with 28 quick-reference anti-patterns.

Usage

/review-sdk-changelog developer-guide/release-notes/android-sdk.mdx
/review-sdk-changelog developer-guide/release-notes/ios-sdk.mdx

Test plan

  • Verify /review-sdk-changelog tab-completes after checkout.
  • Run on android-sdk.mdx — confirm BOM version mismatch and Inbox UI 4.40 are flagged as Blocking.
  • Run on ios-sdk.mdx — confirm missing link on Self-Handled Background Push entry is flagged as Content gap.
  • Confirm findings are grouped Blocking / Content gap / Style with line numbers.

🤖 Generated with Claude Code

Adds a Claude Code skill for reviewing Android and iOS SDK changelog
files from the perspective of a junior developer deciding whether to
upgrade. Covers upgrade clarity, badge consistency, version accuracy,
link correctness, and detailed writing quality guidelines with
before/after examples for each entry type.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 14, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
moengage 🟢 Ready View Preview May 14, 2026, 9:49 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mallikarjun-dhulange mallikarjun-dhulange merged commit 6fc8f40 into main May 15, 2026
7 checks passed
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