explaingit

coleam00/context-engineering-intro

13,310PythonAudience · vibe coderComplexity · 2/5Setup · easy

TLDR

A starter template that helps AI coding assistants produce better results by giving them structured context about your project before they write any code.

Mindmap

mindmap
  root((repo))
    What it does
      Context for AI tools
      Structured templates
      Two-step workflow
    Key Files
      CLAUDE.md rules
      INITIAL.md feature request
      examples folder
      PRP template
    Workflow
      Run generate-prp
      Run execute-prp
      AI writes and tests
    Use Cases
      AI-assisted coding
      Feature planning
      Pattern teaching
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Give Claude Code or another AI assistant full context about your project structure so it writes code matching your patterns.

USE CASE 2

Generate a detailed implementation plan for a new feature before asking AI to write the code.

USE CASE 3

Use the /execute-prp command to have AI implement a feature step by step with automatic test-and-fix loops.

USE CASE 4

Build a library of code examples that teach your AI assistant your preferred file structure and testing conventions.

Tech stack

PythonClaude Code

Getting it running

Difficulty · easy Time to first run · 30min

Requires Claude Code CLI, customize CLAUDE.md and the examples folder for your own project to get useful results.

In plain English

Context Engineering Intro is a template repository for getting more reliable results from AI coding assistants. The central argument is that most failures when using AI to write code are not model failures but context failures: the AI does not have enough information about what you are building, how your project is structured, or what patterns you follow. This template gives you a structured starting point for supplying that context. The main pieces are a CLAUDE.md file containing project-wide rules that the AI reads at the start of every session, an INITIAL.md file where you describe a feature you want to build, and an examples folder where you place existing code the AI can learn patterns from. The README treats the examples folder as critical: concrete code samples of your file structure, testing conventions, and integration patterns produce better outputs than text descriptions alone. The workflow has two steps handled by custom slash commands. Running /generate-prp reads your feature description, analyzes the codebase for existing patterns, gathers relevant documentation, and writes a detailed implementation plan called a PRP (Product Requirements Prompt). Running /execute-prp reads that plan and carries out the work step by step, running tests and fixing issues as it goes. The repository ships with the command definitions for both slash commands, a base PRP template, an example feature request, and a completed example PRP. You use it by cloning it, editing the rules and description files for your own project, and building out the examples folder. The README notes the workflow is centered on Claude Code but the approach applies to other AI coding assistants as well.

Copy-paste prompts

Prompt 1
I cloned context-engineering-intro. Help me fill out CLAUDE.md with rules for a FastAPI project that uses PostgreSQL and pytest, covering the patterns I want the AI to follow.
Prompt 2
Write an INITIAL.md feature request for adding JWT authentication to my FastAPI app, following the context-engineering-intro format.
Prompt 3
Using the /generate-prp command approach, create a Product Requirements Prompt for building a file upload feature in my Python web app.
Prompt 4
What code files should I put in my examples/ folder for a React and TypeScript frontend project to best teach an AI my coding patterns?
Open on GitHub → Explain another repo

← coleam00 on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.