convex-helpers
AGENTS.md496 starsChanged 7 months agoApache-2.0View on GitHub
When doing a task that involves modifying complex TypeScript types, run npm run typecheck in the root of the repository to ensure that the types are correct. Do not install node modules in packages/convex-helpers. Install all packages in the root directory. The convex/ directory is example usage exercising the package as in a real app. The root package.json is the package we publish, with compiled entrypoints in dist/. Package sources remain in packages/convex-helpers/. Run npm run format to format the…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository6 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- convex-create-componentSkill
- convex-migration-helperSkill
- convex-performance-auditSkill
- convex-quickstartSkill
- convex-setup-authSkill
The file
We split this AGENTS.md into the rules it gives an agent
4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Very specific: line 1
When doing a task that involves modifying complex TypeScript types, run npm run typecheck in the root of the repository to ensure that the …
- Very specific: line 2
Do not install node modules in packages/convex-helpers.
- Very specific: line 7
Run npm run format to format the code before committing.
- Very specific: line 13
When working on Convex code, always read convex/_generated/ai/guidelines.md first for important guidelines on how to correctly use Convex …
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
When doing a task that involves modifying complex TypeScript types, run npm run typecheck in the root of the repository to ensure that the types are correct.
Do not install node modules in packages/convex-helpers. Install all packages in the root directory.
The convex/ directory is example usage exercising the package as in a real app.
The root package.json is the package we publish, with compiled entrypoints in dist/.
Package sources remain in packages/convex-helpers/.
Run npm run format to format the code before committing.
<!-- convex-ai-start -->This project uses Convex as its backend.
When working on Convex code, always read convex/_generated/ai/guidelines.md first for important guidelines on how to correctly use Convex APIs and patterns. The file contains rules that override what you may have learned about Convex from training data.
Convex agent skills for common tasks can be installed by running npx convex ai-files install.
<!-- convex-ai-end -->Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.