README

A standardized template for any software development project with GitHub Copilot integration and AI-powered workflows.

Features

🤖 AI-Optimized: Pre-configured GitHub Copilot instructions, custom agents, and agent skills
📊 Flexible Structure: Adaptable to any project type (Web, Game, ML/AI, Modding, etc.)
🔄 Reproducible: Version control, configuration management, type-safe code practices
📝 Documentation-First: Structured documentation workflow with templates
🧩 Extensible: Agent skills for automated workflows and best practices
🌐 Multi-Language: Support for Korean + English documentation

Quick Start

# Clone your project
git clone <repository-url>
cd <project-directory>

# Install dependencies (adapt to your project)
# Python: uv sync
# Node.js: npm install
# .NET: dotnet restore
# RimWorld Mod: See documents/BUILD_GUIDE.md

# Run your project (adapt to your project)
# Python: uv run python src/main.py
# Node.js: npm start
# .NET: dotnet run
# RimWorld Mod: Copy to mods folder and launch game

Project Structure

.
├── .github/
│   ├── agents/              # Custom Copilot agents (.agent.md)
│   ├── skills/              # Agent Skills (workflows)
│   ├── prompts/             # Reusable prompt templates
│   └── copilot-instructions.md  # Global Copilot instructions
├── src/                     # Source code (adapt to your project)
├── tests/                   # Test files
├── scripts/                 # Automation scripts
├── documents/               # Curated documentation
│   ├── final/               # Published reports
│   ├── drafts/              # Work in progress
│   ├── reference/           # External references
│   │   ├── papers/          # Academic paper summaries
│   │   └── technical/       # API docs, technical guides
│   ├── templates/           # Document templates
│   ├── PROJECT.md           # Project overview (start here!)
│   ├── AGENT_MANUAL.md      # AI agent operation manual
│   ├── BUILD_GUIDE.md       # Build instructions
│   ├── TEST_GUIDE.md        # Testing procedures
│   ├── QUICKSTART.md        # Quick start guide
│   └── CHANGELOG.md         # Change history
├── reference_codes/         # Reference code from external projects
├── results/                 # Execution results (if applicable)
├── logs/                    # Application logs
├── temp/                    # Temporary files (gitignored)
├── AGENTS.md                # Agent documentation (must-read!)
└── README.md                # This file

Note: The structure above is flexible. Adapt it to your project type:

RimWorld Mod: See documents/PROJECT.md for actual structure
ML/AI Research: Add configs/, results/, checkpoints/
Web Development: Add public/, api/, frontend/, backend/
Game Development: Add assets/, scenes/, prefabs/

AI Agents

This template includes pre-configured GitHub Copilot agents for common development tasks:

Agent	Description
`@orchestrator`	Autonomous Task Manager & Master Planner
`@fixer`	Autonomous problem-solving & execution agent
`@doc-writer`	Documentation Writer (creates structured docs)
`@doc-reviewer`	Documentation Reviewer (quality checks)
`@code-generator`	Code generation with best practices
`@code-quality-reviewer`	Code quality & standards compliance
`@validator`	Verification and validation
`@architect`	System architecture & design
`@research-gemini`	Implementation-focused research
`@research-gpt`	Theory-focused research
`@research-claude`	System/Safety-focused research
`@planner-*`	Strategic planning (Gemini/GPT/Claude variants)
`@idea-generator-*`	Ideation (Gemini/GPT/Claude variants)

See AGENTS.md for full documentation.

Agent Skills

Agent Skills are specialized workflows automatically loaded by Copilot:

Skill	Description
`documentation`	Standardized doc creation and formatting
`code-review`	Code quality checklist and best practices
`deep-research`	Recursive research workflow (STORM-style)
`data-analysis`	Result visualization and statistical comparison
`skill-extension`	Create and extend agent skills
`external-skill-generation`	Generate skills from external documentation

See AGENTS.md for usage examples.

Documentation Workflow

Document Types

Type	Location	Purpose
Final Reports	`documents/final/`	Completed, reviewed documents
Drafts	`documents/drafts/`	Work in progress
Technical Reference	`documents/reference/technical/`	API docs, guides
Paper Summaries	`documents/reference/papers/`	Research summaries
Templates	`documents/templates/`	Standard forms

Documentation Guidelines

Write drafts in documents/drafts/ - Not ready for publication
Move to documents/final/ - After review and approval
Use Memory MCP for notes - Don't create *.memory.md files
Follow project language policy - See .github/copilot-instructions.md

Development Workflow

Working with Agents

Check AGENTS.md - Find the right agent for your task
Invoke agent - Use @agent-name in Copilot chat
Provide context - Clear requirements and constraints
Review output - Validate and iterate

Using Skills

Skills are automatically loaded by Copilot when relevant. You can also manually load them:

# Load a skill
@workspace /skills documentation

# Use skill in context
@doc-writer Create a technical guide for feature X using the documentation skill

Memory Management

Use Memory MCP (mcp_memory_* tools) for transient data:

Observations/Notes → mcp_memory_store
Prior context lookup → mcp_memory_search
List all memories → mcp_memory_list

DO NOT create local *.memory.md files.

Project Adaptation Guide

For Different Project Types

RimWorld Mod Development:

Structure: See documents/PROJECT.md
Build: MSBuild, .NET Framework 4.8
Test: In-game testing with Debug Mode

ML/AI Research:

Add: configs/, results/, checkpoints/
Tools: PyTorch, TensorFlow, Weights & Biases
Test: Reproducibility checks, statistical validation

Web Development:

Add: frontend/, backend/, api/, public/
Tools: React, Node.js, Express, Next.js
Test: Unit tests, integration tests, E2E tests

Game Development:

Add: assets/, scenes/, scripts/, prefabs/
Tools: Unity, Unreal, Godot
Test: Playtesting, performance profiling

General Software:

Standard structure works out of the box
Adapt as needed for your tech stack

Customization Steps

Update documents/PROJECT.md - Add project-specific details
Configure .github/copilot-instructions.md - Set coding standards
Add custom agents - Create .github/agents/<name>.agent.md
Create skills - Add .github/skills/<name>/SKILL.md
Update AGENTS.md - Document your custom agents

Getting Started

First-time project setup:

Read documents/PROJECT.md - Understand your project
Check AGENTS.md - Learn about available agents
Review documents/QUICKSTART.md - Quick start guide
Follow documents/BUILD_GUIDE.md - Build your project
Use documents/TEST_GUIDE.md - Test your work

Documentation

documents/PROJECT.md - Project overview and specifics
AGENTS.md - AI agent documentation (must-read!)
documents/AGENT_MANUAL.md - AI agent operation manual
documents/QUICKSTART.md - Quick start guide
documents/CHANGELOG.md - Change history
.github/copilot-instructions.md - Development guidelines

Reference Codes

The reference_codes/ directory stores external code used as reference during development.

Management Principles:

✅ Include: External projects, library examples, prototype code
❌ Exclude: Active project code (src/), archived versions (archive/), documentation (documents/)

Guidelines:

Verify and comply with licenses
Document version/date information clearly
Reference code is read-only (no direct modifications)
Regularly update or remove outdated references

See documents/PROJECT.md for project-specific references.

Contributing

This is a template project. To use it:

Clone or fork this repository
Adapt the structure to your project type
Update documents/PROJECT.md with your project details
Customize agents and skills as needed
Remove this section and add your project-specific content

License

[Specify your license]

Links

Template Version: 1.0.0
Last Updated: 2026-02-23

goemktg / seat-custom-plugin

Maintainers

Details