Introduction to Rules Files
- π A rules file provides context to AI coding assistants, making them more reliable development partners.
- π€ The file is used by popular code editors, including VS Code, Cursor, and Wind Surf, to generate higher-quality code.
- π The location of the rules file varies by editor: VS Code uses GitHub Code Pilot instructions, Cursor uses a Cursor rules file, and Wind Surf uses a Wind Surf rules file.
Creating and Maintaining Rules Files
- π The rules file should include project context, such as a brief description of the project's purpose and high-level goals.
- ποΈ Outlining the rough structure of the codebase helps AI understand the project's organization.
- π Specifying the tech stack used in the project ensures AI generates code consistent with the project's requirements.
- π The file should be concise, only including rules that address consistent mistakes made by the AI.