feature-contract

Generate implementation contracts defining scope, affected files, APIs, risks, and test plans for FastLED changes.

7.5k|1.8k|Updated Nov 10, 2013
One-click install
npx skills add https://github.com/FastLED/FastLED --skill feature-contract
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: feature-contract
Source: https://github.com/FastLED/FastLED/tree/main/.claude/skills/feature-contract
Command: npx skills add https://github.com/FastLED/FastLED --skill feature-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate an implementation contract before coding to define scope and governance around changes to the FastLED codebase.

Core Features & Use Cases

  • Scope definition: Document the requested change, goals, non-goals, and acceptance criteria to prevent scope creep.
  • Impact analysis: Identify affected files, public APIs, hardware/platform implications, and associated risks.
  • Test plan: Define validation strategy including host unit tests, compile checks, and hardware validation where applicable.
  • Review workflow: Establish sign-off and stakeholder reviews before changes are written.

Quick Start

Draft the contract as the first step before any code changes.

Frequently Asked Questions about feature-contract

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

FAQPage Schema
How do I define scope and assess risks before starting code changes on a software project?

An implementation contract defines scope before coding by documenting requested changes, goals, non-goals, and acceptance criteria to prevent scope creep. It identifies affected files, public APIs touched, hardware implications, and associated risks for comprehensive risk assessment prior to development.

What is an implementation contract and when do I need one for feature work or refactoring?

An implementation contract is a formal document generated before coding to govern changes across platforms. You need one for feature work, bug fixes, driver additions, or refactors to establish stakeholder sign-off and review workflows before any code is actually written.

How do I create a test plan and impact analysis for platform-specific code changes?

To create a test plan and impact analysis, draft an implementation contract detailing affected files, API changes, and platform impact. The contract mandates a validation strategy including host unit tests, compile checks, and hardware validation where applicable for the specific platform.

Can I use a formal contract workflow for bug fixes and driver additions across all platforms?

Yes, a formal contract workflow applies to bug fixes, driver additions, and refactors across all platforms. It details affected files, APIs touched, platform impact, and a test plan, ensuring governance and stakeholder sign-off regardless of the specific development task.

What's the best way to prevent scope creep when modifying public APIs in a codebase?

The best way to prevent scope creep is generating an implementation contract as the first step before any code changes. It explicitly documents requested changes, non-goals, and acceptance criteria, establishing a formal review workflow to govern API modifications.

Why should I document non-goals and acceptance criteria before writing code for a new feature?

Documenting non-goals and acceptance criteria before coding establishes clear boundaries for the requested change. This formal contract prevents scope creep, defines validation strategy, and enables stakeholder reviews to ensure the feature meets defined expectations.