Files reference

Your project's homepage on GitHub, npm, and PyPI. The first file anyone reads — it determines whether they use your project or move on. MDPilot generates a production-grade README grounded in your actual tech stack, scripts, and project type.

Universal AI coding agent instructions. Tells every AI tool how to work in your project — coding style, available scripts, permission boundaries. Without it, agents guess and often guess wrong. The single most high-leverage file for AI-assisted development.

Claude Code reads this automatically at the start of every session. Contains gotchas and constraints Claude would get wrong from the code alone — project-specific conventions, known footguns, decisions that look wrong but are intentional. Prevents repeated clarification questions.

Structured task context generated from a ticket, thread, or description. Contains the goal, acceptance criteria, constraints, and an Agent Prompt block — everything an AI agent needs to start coding with zero clarifying questions. Generated by Task mode.

Engineering specification: user story, functional requirements, technical approach, and testing plan. Use alongside TASK.md for planning, estimation, and review before implementation starts. Generated by Task mode.

Defines a reusable capability your AI agent can invoke — like a function the agent can call. The description field is critical: it determines whether the skill gets triggered at the right moment. Generated by Generate mode.

Nine-section ecosystem spec: Visual Theme, Color Palette, Typography, Component Stylings, Layout, Depth & Elevation, Do's and Don'ts, Responsive Behavior, and Agent Prompt Guide. Follows the getdesign.md / awesome-design-md format so any tool that reads DESIGN.md gets exact tokens — not invented values. Generated by Generate mode.

GitHub surfaces this to anyone opening an issue or PR. Answers "how do I contribute?" — branch naming, commit conventions, PR process, development setup — so you don't have to answer it repeatedly. Generated by Generate mode.

GitHub's Security tab links to this. Without it, vulnerability reporters may open public issues exposing the flaw. Covers your supported versions, how to report, and your response timeline. Generated by Generate mode.

Unlike CLAUDE.md (permanent project context), CONTEXT.md is your daily scratchpad — what you're working on today, known broken things, decisions in progress, what to ignore. Update it at the start of each coding session. Generated by Generate mode.