trellis-update-spec

Capture and document executable contracts and coding conventions from completed tasks.

7.3k|365|Updated May 31, 2024
One-click install
npx skills add https://github.com/EcoPasteHub/EcoPaste --skill trellis-update-spec-ecopastehub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: trellis-update-spec
Source: https://github.com/EcoPasteHub/EcoPaste/tree/main/.cursor/skills/trellis-update-spec
Command: npx skills add https://github.com/EcoPasteHub/EcoPaste --skill trellis-update-spec-ecopastehub

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps developers capture and document executable contracts and coding conventions, ensuring that valuable knowledge is preserved and easily accessible for future reference.

Core Features & Use Cases

  • Capture Executable Contracts: Record and organize executable contracts learned from debugging, implementation, or discussions.
  • Code-Spec Depth: Apply code-spec depth when changes touch infra or cross-layer contracts.
  • Spec Structure Overview: Provides a guide on how to structure and organize code specifications and guides.
  • Update Process: Offers a step-by-step process for updating code specifications based on new learnings.

Quick Start

After completing a task or fixing a bug, use the 'trellis-update-spec' skill to document the changes and update the relevant code-spec documents.

Frequently Asked Questions about trellis-update-spec

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

FAQPage Schema
How do I document executable contracts and coding conventions after fixing a bug?

You document executable contracts by capturing changes learned from debugging and applying a step-by-step update process to organize code specifications, ensuring knowledge is preserved for future reference.

What is the best way to preserve code specification knowledge for future reference?

The best way to preserve code specification knowledge is to organize executable contracts and coding conventions into structured developer documentation, making valuable insights easily accessible for future reference.

When do I need to apply code-spec depth when updating developer documentation?

You need to apply code-spec depth when changes touch infrastructure or cross-layer contracts, ensuring that code specifications are thoroughly documented and updated based on new learnings.

How should I structure code specifications to keep developer documentation organized?

You should structure code specifications by following a spec structure overview guide that organizes executable contracts and coding conventions, ensuring documentation remains accessible and logically arranged.

Does updating code specifications require prior knowledge of coding conventions?

Updating code specifications requires an understanding of coding conventions and code specifications, enabling developers to accurately document executable contracts and apply updates based on new learnings.