Skip to content

Instantly share code, notes, and snippets.

@zachdaniel

zachdaniel/AGENTS.md

Created July 1, 2025 12:13
Show Gist options
  • Save zachdaniel/26fb60986fa5a9e47e37ff3f88e64e64 to your computer and use it in GitHub Desktop.
Save zachdaniel/26fb60986fa5a9e47e37ff3f88e64e64 to your computer and use it in GitHub Desktop.
Download ZIP
an agents md example for a PR to Phoenix
Raw
AGENTS.md

Usage Rules

IMPORTANT: Consult these usage rules early and often when working with the packages listed below. Before attempting to use any of these packages or to discover if you should use them, review their usage rules to understand the correct patterns, conventions, and best practices.

phoenix usage

Peace of mind from prototype to production

How to use Phoenix

this file would describe high level rules for using Phoenix. It should have:

  • prevention against common footguns that the agent makes
  • Core guidelines that set agents on the correct path
  • breadcrumbs, but not full context. Link to docs for more etc.

It should not have:

  • Ecto usage guidelines
  • other dependency usage rules, those live in those dependencies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment