code-spec-backfill

Solid

Backfill function-level contracts (docstrings, type annotations) where missing. Report unresolvable gaps with misuse scenarios. Incremental by default (state-driven).

Testing & QA 124 stars 24 forks Updated 4 days ago Apache-2.0

Install

View on GitHub

Quality Score: 84/100

Stars 20%
70
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

**STATE_FILE** = `specs/.code-spec-backfill/state.yaml` tracks per-file review freshness: # Code Spec Backfill Constructive first, diagnostic second. Write the contract where you can infer it. Report what you can't resolve. # Core Heuristic Only act on a gap if you can write a plausible incorrect usage that a senior engineer might write based on the function's public interface. The misuse scenario IS the quality gate — if no one would get burned, it's not a gap worth addressing. **Misuse scenario format:** `[caller_assumption] × [actual_behavior] → [consequence]` Example: `"Returns empty list when no results" × "Raises NoResultError" → "Caller crashes on valid empty-result case"` # Hard Boundaries - NEVER modify behavior — only add/improve documentation and type annotations. - NEVER weaken existing contracts (e.g. broadening a type hint to accept None). - Unexported/private members: only if explicitly scoped. ## No-Tautology Rule A docstring that restates the function signature adds no value. Do not write docstrings that merely echo parameter names, types, or the function name as prose. **Tautological (do not write):** ```python def get_user(user_id: int) -> User: """Get a user by user ID. Args: user_id: The user ID. Returns: The user. """ ``` **Valuable (write this):** ```python def get_user(user_id: int) -> User: """Fetch user from database. Raises UserNotFoundError if no user exists with this ID. Result is cached for th...

Details

Author
liza-mas
Repository
liza-mas/liza
Created
2 months ago
Last Updated
4 days ago
Language
Go
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

spec-writer

Generate structured software specifications for features, bug fixes, and products. Use when the user wants to create a spec, PRD, feature brief, requirements document, or when starting any new implementation that needs a specification first. Invoke via /spec-writer or when the user says "write a spec", "spec this out", "create a spec", "I need a spec for...", or describes a feature they want to build. Produces adaptive-complexity specs with Job Stories, Gherkin acceptance criteria, and three-tier boundaries. Output is a markdown file ready for agent execution or human review.

30 Updated 4 weeks ago
SamJHudson01
Testing & QA Solid

spec-creator

Turn a feature request into implementation-ready spec files for a coding agent. Use whenever the user wants to plan, scope, or write a spec for a feature about to be built — "write a spec for X", "plan feature Y", "how should we build Z", "draft an implementation plan". Produces a parent epic plus one file per independently-buildable slice. Prefer over write-spec when the audience is a coding agent, not an exec. Auto-applies the KeeForge overlay when the repo looks like KeeForge.

13 Updated 5 days ago
crazytan
Testing & QA Featured

specify

Create a comprehensive specification from a brief description. Manages specification workflow including directory creation, README tracking, and phase transitions.

246 Updated 1 weeks ago
rsmdt
Web & Frontend Solid

create-spec

ユーザーと対話しながら機能仕様を策定し、Notion に自動でドキュメント化するスキル。「仕様を作ろう」「スペックを書いて」「仕様を詰めよう」などの指示で呼び出される。

14 Updated 4 days ago
suzuki3jp
Testing & QA Solid

speckit-implement

Execute the implementation plan by processing and executing all tasks defined in tasks.md

28 Updated 1 weeks ago
WahidBitar