counterfact-maintenance

Validates contributor PRs against repository conventions for tests, docs, and changesets.

169|19|Updated Apr 8, 2022
One-click install
npx skills add https://github.com/counterfact/api-simulator --skill counterfact-maintenance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: counterfact-maintenance
Source: https://github.com/counterfact/api-simulator/tree/main/.github/skills/counterfact-maintenance
Command: npx skills add https://github.com/counterfact/api-simulator --skill counterfact-maintenance

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps contributor changes aligned with repository test patterns, diagnostics, release/versioning workflow, documentation requirements, and compatibility.

Core Features & Use Cases

  • Validates that PRs conform to project conventions for tests, docs, and changesets.
  • Guides maintainers to preserve compatibility and documentation promises during releases.
  • Use Case: When finalizing a contributor PR that touches code, tests, or docs, this skill ensures alignment with established standards.

Quick Start

Review the PR against the project's test, docs, and changeset conventions as described in this skill.

Frequently Asked Questions about counterfact-maintenance

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

FAQPage Schema
How do I ensure contributor PRs align with repository tests and documentation?

Validate PR changes against project conventions for test patterns, diagnostics, release workflows, and docs across src, test, and docs directories to ensure alignment and compatibility.

What is changeset consistency when finalizing a pull request?

Changeset consistency ensures that code modifications in src/**/*.ts are accompanied by corresponding .changeset/*.md files, preserving release versioning traceability and compatibility promises during PR finalization.

How do I validate frontmatter and changesets for TypeScript pull requests?

Validate frontmatter and changesets by checking that PRs touching src/**/*.ts and test/**/*.ts include proper .changeset/*.md entries and conform to repository documentation and test standards.

When do I need to regenerate tests and docs for a contributor PR?

Regenerate tests and docs when contributor changes alter code behavior in src/**/*.ts, requiring updated test/**/*.ts and docs/**/*.md files to preserve compatibility, traceability, and diagnostic accuracy.

Does this maintenance skill work with changeset and markdown documentation files?

Yes, it enforces alignment across .changeset/*.md and docs/**/*.md files, validating frontmatter and change-set consistency to maintain release workflow and documentation compatibility.

What are the limitations of automating PR alignment for tests and docs?

Limitations include relying on established patterns in src, test, docs, and changeset directories; it guides regeneration but cannot auto-generate complex test logic or nuanced documentation content.