TLDR · PROGRAMMING, DESIGN & DATA SCIENCE

HOW TO WRITE A GREAT AGENTS.MD: LESSONS FROM OVER 2,500 REPOSITORIES

github.blog12 min read

Summary from the TLDR newsletter

GitHub's agents.md feature allows developers to create agents with custom instructions. agents.md is where developers define all of the specifics, provide code style examples, and set clear boundaries of what not to do. Most agent files fail because they're too vague. The best files provide agents with a clear job or persona, exact commands to run, well-defined boundaries to follow, and clear examples of good output for the agent to follow.