Instructions

In this file i'm providing instructions for GitHub Copilot on how to assist me while coding in this project.

Context

Read the .system/constants.md

Available Skills

This project has reusable skills that can be invoked by agents to perform common tasks:

finalize_branch

Location: .system/skills/finalize_branch.md

Purpose: Squashes all commits on current feature branch, merges to main, and deletes the feature branch with comprehensive edge case handling.

Invocation: Agents can reference this skill to clean up and integrate completed work.

Custom Commands

This project uses custom agent commands to streamline feature development and planning:

@Vi - Analyst Agent (Planning)

Command: @Vi <feature description>

Purpose: Loads the analyst agent from .system/agents/analyst.md to create a comprehensive execution plan for a given feature request.

What it does:

Analyzes the feature request
Creates a detailed execution plan with user stories
Documents acceptance criteria and technical specifications
Identifies dependencies and risk assessment
Generates a PLAN_FILE at docs/plans/<outcome-name>.md

Example Usage:

@Vi Add a new enemy type that shoots homing missiles with adaptive difficulty scaling

Workflow: Always use @Vi first when you want to plan a complex feature or enhancement.

@dev - Developer Agent (Implementation)

Command: @dev <outcome_name>

Purpose: Loads the developer agent from .system/agents/developer.md to implement the execution plan created by @Vi and deliver production-ready code.

What it does:

Reads the PLAN_FILE from docs/plans/<outcome-name>.md
Creates a feature branch for isolated development
Implements each story with code, testing, and documentation
Verifies implementation against original requirements
Generates an OUTCOME_FILE at docs/outcomes/<outcome-name>.md

Parameters:

<outcome_name>: The outcome name in the format used in the PLAN_FILE (e.g., "FirstPersonSpaceShooter", "EnhancedGameplayFeatures")

Example Usage:

@dev EnhancedGameplayFeatures

Workflow: Use @dev after @Vi has created a PLAN_FILE. The outcome_name should match the PLAN_FILE name in docs/plans/.

Development Workflow

Planning Phase: Use @Vi <feature description> to create a plan
Implementation Phase: Use @dev <outcome_name> to implement the plan
Review: Review the generated pull request and test results
Merge: Merge the feature branch when approved

Project Structure References

Plans: docs/plans/<outcome-name>.md
Outcomes: docs/outcomes/<outcome-name>.md
Agents: .system/agents/
- analyst.md - Planning and analysis agent
- developer.md - Implementation and delivery agent
Constants: .system/constants.md - Project path and variable definitions

2.9 KiB Raw Blame History