async-test-and-doc-sync

Aligns PHPUnit tests, PHPDoc blocks, and guides with current public behavior.

1.1k|250|Updated Aug 12, 2015
One-click install
npx skills add https://github.com/discord-php/DiscordPHP --skill async-test-and-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: async-test-and-doc-sync
Source: https://github.com/discord-php/DiscordPHP/tree/main/.agents/skills/async-test-and-doc-sync
Command: npx skills add https://github.com/discord-php/DiscordPHP --skill async-test-and-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintain test and documentation alignment — PHPUnit tests, async testing patterns, PHPDoc contracts, guide pages, and documentation workflow. Use when adding tests, updating docs, or changing public behavior.

Core Features & Use Cases

  • Synchronize unit tests, integration tests, PHPDoc blocks, and long-form guides with the current public behavior of parts, repositories, builders, and helpers.
  • Treat tests and docs as contract surfaces; ensure PHPDoc blocks reflect available properties and methods used by IDEs and tooling.
  • Align guide pages and docs site content with code changes to minimize drift and migration confusion.

Quick Start

Run this skill whenever you add tests, update docs, or change public behavior to keep tests and docs in sync.

Frequently Asked Questions about async-test-and-doc-sync

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

FAQPage Schema
How do I keep PHPUnit tests and PHPDoc blocks aligned with code changes?

You can keep PHPUnit tests and PHPDoc blocks aligned with code changes by synchronizing unit tests, integration tests, and documentation blocks with the current public behavior of repositories and helpers, ensuring contract surfaces remain maintained before release.

What is the best way to prevent documentation drift when updating public behavior?

To prevent documentation drift when updating public behavior, treat tests and docs as primary contract surfaces, applying alignment across guide pages and PHPDoc blocks whenever changes are made to parts or builders.

When do I need to synchronize long-form guides and PHPDoc contracts?

You need to synchronize long-form guides and PHPDoc contracts whenever you add tests, update documentation, or change the public behavior of parts, repositories, builders, and helpers to minimize migration confusion and ensure IDE tooling accuracy.

How do I ensure guide pages reflect recommended usage after modifying repositories and builders?

To ensure guide pages reflect recommended usage after modifying repositories and builders, apply alignment across tests and docs to enforce that guide pages and documentation site content match the current public behavior and maintained contract surfaces.

Does treating tests as contract surfaces help maintain async testing patterns and documentation workflow?

Treating tests as contract surfaces helps maintain async testing patterns and documentation workflow by enforcing that PHPUnit tests, PHPDoc contracts, and guide pages remain aligned with the actual public behavior of the codebase before release.

Why does documentation drift happen and how do I minimize migration confusion?

Documentation drift happens when code changes outpace guide pages and PHPDoc blocks, causing migration confusion. You minimize this by applying alignment across tests and docs whenever public behavior changes, ensuring guide pages reflect recommended usage.