agentleFS
JoviDeCroockJoviDeCroock/pracht/AGENTS.md

pracht

AGENTS.md106 starsChanged 7 months agoMITView on GitHub

Always look at the vision_mvp and docs before starting work. Documentation lives in two places and both need updating. docs/ is internal contributor reference — architecture, request flows, workspace shape; nobody outside the repo reads it. examples/docs/src/routes/docs/*.md is the public site (https://pracht.resynapse.dev) that users and coding agents read, and it is also what feeds the generated llms.txt and the agent-skills discovery index. A user-facing change is not finished until the site page covers it. A new page needs its route…

The file

We split this AGENTS.md into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 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.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Always look at the vision_mvp and docs before starting work.

    line 1
  2. Very specific:

    When you finish work update the docs and skills if needed.

    line 4
  3. Very specific:

    When creating a pull request, always follow .github/PULL_REQUEST_TEMPLATE.md and fill any non-applicable sections with N/A.

    line 7

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Always look at the vision_mvp and docs before starting work. Documentation lives in two places and both need updating. docs/ is internal contributor reference — architecture, request flows, workspace shape; nobody outside the repo reads it. examples/docs/src/routes/docs/*.md is the public site (https://pracht.resynapse.dev) that users and coding agents read, and it is also what feeds the generated llms.txt and the agent-skills discovery index. A user-facing change is not finished until the site page covers it. A new page needs its route in examples/docs/src/routes.ts and a nav entry in examples/docs/src/nav.ts. Never point a site page at a docs/*.md path — that file does not exist for a reader on the site. Write a site page for someone using the feature: what to do, and what they will observe. Validation, rejection, and hardening behaviour is documented by its error message, not in prose, so a bug fix or review finding normally changes no site page. When a page must change, rewrite the affected sentence instead of appending a clause to it. Implementation detail and exhaustive guarantees belong in docs/. examples/docs/test/site-content.test.ts caps paragraphs and list items at 600 characters and pages at 2,500 words, and checks every internal link. When you finish work update the docs and skills if needed. When making changes that affect published packages, create a changeset (.changeset/<name>.md) describing the change. Use patch/minor/major as appropriate. Normally use one direct sentence stating the user-visible outcome. Add a second sentence only when an important behaviour needs clarification; add a short migration note or example only for a breaking change. A changeset becomes a CHANGELOG entry, not a miniature PR description: never narrate the implementation, investigation, tests, edge cases, rationale, benchmarks, alternatives, or review history. If it needs headings, bullets, or multiple paragraphs, it is too long. Before committing, always run pnpm run verify. It builds, formats, lints, then runs typecheck, the unit tests, and the bench:check client-byte gate in parallel when system load permits, then e2e, and prints output only for failing steps. The build and typecheck steps are incremental, so an unchanged package is not rebuilt or re-checked — do not reach for --skip-build. Pass --check to report formatting and lint instead of rewriting files. When creating a pull request, always follow .github/PULL_REQUEST_TEMPLATE.md and fill any non-applicable sections with N/A.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.