Imported from supagetto/README.ai (
AGENTS.md). Install upstream withnpx skills add supagetto/README.ai. Copyright stays with the author.
AGENTS.md
General
- Name rule, skill, and agent files and directories in kebab-case:
lowercase words separated by hyphens (e.g.
git-guardrails.md,auditing-overengineering/). - Wrap all lines to a maximum of 80 columns.
- Use correct punctuation.
- When a YAML
descriptionfield doesn't fit on one line within that limit, use the folded style (description: >) with wrapped, indented lines.
Creating Rules
-
Keep each rule specific — one concern per file, not a broad catch-all.
-
Add a file in
rules/. Only add frontmatter for file-scoped rules, usingpaths:, e.g.:--- paths: - 'src/**/*.{ts,tsx}' - 'lib/**/*.ts' - 'tests/**/*.test.ts' ---
Creating Skills
- Name it as a gerund phrase (e.g.
auditing-overengineering).