fraconca/ai-ready-context-template-engine

This project is a template you drop into a new or existing coding project to give AI coding assistants like Cursor, Windsurf, or Claude a clear, organized set of files to read before they start writing code. Instead of relying on one giant instruction file or a tool-specific config, it sets up a small folder structure with a standard entry point file that AI tools and web crawlers already know to look for, plus a dedicated folder holding separate files for the project's changelog, its setup and testing instructions, its goals and boundaries, and the persona and rules the AI should follow while coding. A setup script lets you generate this structure for a project written in any of ten common technology stacks, including plain HTML and JavaScript, TypeScript with Next.js, Python for AI and data work, Go, Node.js, PHP, Java, dotnet, Ruby, or Shopify's theme language, each coming with matching starter files and settings already filled in. Running the script is a single command you paste into a terminal, and Windows users are told to run it through Git Bash or WSL since regular Command Prompt and PowerShell cannot run this kind of script. After generating the workspace, you are expected to fill in a few files with details about your actual project, such as your exact tech choices, your product's goals and what is out of scope, and your first task to work on. The README suggests giving the AI a short standard message pointing it to these files whenever you open the project for the first time, so it reads the map and follows the guidelines before touching any code. The included FAQ argues this approach avoids the downsides of one long prompt, since agents tend to lose track of details buried in the middle of a huge block of text, and that splitting instructions into focused files also lets the structure scale to large projects made of many smaller subprojects. The template is released under the MIT license.