The foundation / Code Dev Home

Give the project a clear introduction.

A repository becomes easier to work in when its important context has an obvious place. Prepare a short introduction for your AI coding assistant: what the project does, how its main behavior is organized, and which instructions govern work inside it.

Start with the facts that change decisions

Name the application entry points, the package or service you are working on, and one nearby implementation that reflects current conventions. Include the usual verification commands and any required local services. Avoid copying the entire file tree; it rarely explains which parts matter for the next task.

Give every important note a source

A statement such as "the service owns validation" should point to the relevant code or project instruction. Mark assumptions and open questions separately. When the repository changes, revisit the note before reusing it. A context document is a useful orientation aid, not a guarantee that every detail remains current.

A compact project introduction

Adapt to your project

Purpose: What this project does and for whom.
Current area: Package, service, or feature.
Entry points: Relevant files and symbols.
Conventions: Existing patterns and instructions.
Checks: Commands and required local services.
Open questions: Facts still needing confirmation.

How much context is enough?

Enough to explain the task boundary and find supporting evidence. Add source detail when a decision depends on it, and remove stale material that no longer helps.

Shared reference preview: a desktop workspace with a project-folder selector, conversation, and selected model. Final software may differ. Reference desktop preview; final product screens may differ.