branch-plan

Generate a structured Markdown plan file for a Git branch.

1|Updated Nov 18, 2023
One-click install
npx skills add https://github.com/CherrySalmon/tyto --skill branch-plan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: branch-plan
Source: https://github.com/CherrySalmon/tyto/tree/main/.claude/skills/branch-plan
Command: npx skills add https://github.com/CherrySalmon/tyto --skill branch-plan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of planning and documenting new features or refactors by creating a structured plan file for a given Git branch.

Core Features & Use Cases

  • Branch Management: Creates a new Git branch if one doesn't exist.
  • Plan Generation: Generates a detailed Markdown plan file (CLAUDE.<branch-name>.md) using a predefined template.
  • Contextualization: Updates a local context file (CLAUDE.local.md) to reference the new plan.
  • Use Case: Before starting work on a new feature like "implement user authentication," you can run /branch-plan feat/user-auth to create a branch and a comprehensive plan file outlining the backend and frontend tasks, tests, and verification steps.

Quick Start

Use the branch-plan skill to create a plan for the current branch.

Frequently Asked Questions about branch-plan

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

FAQPage Schema
How do I generate a structured plan document for a new Git feature branch?

To generate a structured plan document for a Git feature branch, use the branch-plan skill to create a Markdown plan file that outlines tasks, tests, and verification steps for your new feature.

What is the best way to document vertical slicing and test-first development for Git workflows?

Documenting vertical slicing and test-first development for Git workflows is done by generating a structured Markdown plan file that enforces these guidelines and outlines specific feature tasks and verification steps.

Does branch-plan require Git CLI to create branches and update context files?

Yes, branch-plan requires Git CLI to create new branches if they do not exist and to update local context files with references to the newly generated Markdown plan.

Can I automatically update local context files when planning a new feature branch?

Yes, you can automatically update local context files when planning a feature branch; the skill updates CLAUDE.local.md to reference the newly generated CLAUDE.<branch-name>.md plan file.

How do I validate Markdown output when generating a Git branch plan?

To validate Markdown output when generating a Git branch plan, the skill applies Markdown linting to the final output document to ensure proper formatting and structure of the feature plan.

When should I avoid using a single-file planning approach for feature development?

You should avoid deviating from single-file planning when your feature scope expands beyond vertical slicing limits; the generated plan enforces single-file guidelines to maintain strict feature development boundaries.