Skip to content

Instantly share code, notes, and snippets.

View Breklin's full-sized avatar

Brett Franklin Breklin

View GitHub Profile

AGENTS.md Best Practices for AI Coding Assistants: Comprehensive Guide

AGENTS.md has emerged as the de facto open standard for guiding AI coding assistants, now adopted by over 20,000 repositories and formalized in August 2025 through collaboration between OpenAI, Google, Cursor, Factory, and Sourcegraph. This file acts as a "README for machines"—providing structured, technical context that helps AI assistants write better code from the start. For Python + AWS + Terraform projects, a well-crafted AGENTS.md dramatically reduces friction, ensuring generated code follows your conventions, uses the right tools, and adheres to security requirements.

What is AGENTS.md and why it matters

AGENTS.md is a dedicated Markdown file that complements, not replaces, README.md. While README targets human developers with project overviews and quick-start guides, AGENTS.md contains detailed technical instructions specifically for AI coding agents. Think of it as onboarding documentation for an AI team member: ex

### ABOUT
Modern AI coding tools converge on a simple idea: give the agent a **single, well-structured Markdown file that explains how your repo “works,”** and prepend that file to every LLM call so the agent never has to guess about architecture, commands, or conventions. Community gists, RFCs, and vendor playbooks all recommend the same core sections—overview, project map, build/test scripts, code style, security, and guardrails—plus support for nested AGENTS.md files that override one another hierarchically.

### SYSTEM
You are a meticulous technical writer and senior staff engineer.  
Your task is to create **AGENTS.md** for the repository whose contents are provided below.

### CONTEXT (replace the JSON blocks)
See the attached files.
@Breklin
Breklin / 00 - Cursor AI Prompting Rules.md
Created June 30, 2025 02:37 — forked from aashari/00 - Cursor AI Prompting Rules.md
Cursor AI Prompting Rules - This gist provides structured prompting rules for optimizing Cursor AI interactions. It includes three key files to streamline AI behavior for different tasks.

Cursor AI Prompting Framework — Usage Guide

A disciplined, evidence-first workflow for autonomous code agents


1 · Install the Operational Doctrine

The Cursor Operational Doctrine (file core.md) encodes the agent’s always-on principles—reconnaissance before action, empirical validation over conjecture, strict command-execution hygiene, and zero-assumption stewardship.

@Breklin
Breklin / prettierrc.js
Created June 29, 2025 16:09 — forked from mistical2008/prettierrc.js
Vite config: plain html + vanilla-js
module.exports = {
trailingComma: 'es5',
tabWidth: 4,
semi: false,
singleQuote: true,
}