kata-events-review

Validate CloudEvents documentation and code against Guardia Lexis and Codex.

Updated Sep 3, 2025
One-click install
npx skills add https://github.com/guardiatechnology/design-system --skill kata-events-review
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: kata-events-review
Source: https://github.com/guardiatechnology/design-system/tree/main/.claude/skills/kata-events-review
Command: npx skills add https://github.com/guardiatechnology/design-system --skill kata-events-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents broken or non-compliant CloudEvents contracts by catching violations in event documentation and publisher/consumer implementations before changes ship.

Core Features & Use Cases

  • CloudEvents contract compliance review: Checks CloudEvents structure, required properties, idempotency rules, and JSON/serialization constraints against Guardia Lexis and Codex.
  • Type, naming, and payload validation: Verifies event type format, snake_case segment rules, payload data field presence and shape against the entities catalogs, and flags size/content-type issues.
  • Breaking-change detection: Compares base vs new event catalogs to detect breaking modifications to event contracts and routes a structured review verdict with actionable findings.

Quick Start

Ask the kata to review the CloudEvents event surface for a specific diff and return a Markdown report with compliance verdicts and a list of blockers and warnings.

Frequently Asked Questions about kata-events-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate CloudEvents schema and contract compliance before merging code changes?▼

Validate CloudEvents schema and contract compliance by reviewing event type formats, required idempotency keys, payload schemas, and serialization constraints against Guardia Lexis and Codex before merge.

How do I detect breaking changes in CloudEvents publisher or consumer code?▼

Detect breaking changes in CloudEvents code by comparing base versus new event catalogs to identify modifications to event contracts, routing a structured review verdict with actionable blockers and warnings.

What is the required idempotency key format for CloudEvents payload schema validation?▼

CloudEvents payload schema validation requires checking the idempotency key presence, event type naming conventions, snake_case segment rules, and data field shape against the entities catalogs.

Can I check JSON serialization and size constraints for CloudEvents documentation diffs?▼

Check JSON serialization and size constraints for CloudEvents documentation diffs by scanning files under docs/*/events/events.md and flagging content-type and size issues in a structured Markdown report.

What happens when base version data is unavailable for breaking-change detection in CloudEvents?▼

When base version data is unavailable for breaking-change detection, the CloudEvents review optionally skips breaking-change checks and still produces a structured Markdown report classifying findings as blockers or warnings.