agentleFS
Sign inStart free
boykushboykush/scraps/AGENTS.md

scraps

AGENTS.md45 starsChanged 52 days agoMITView on GitHub

For comprehensive guidelines, see CONTRIBUTING.md

  • 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 repository12 other files it gives its agents.

The file

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

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Plan: Start in Plan mode to analyze requirements and design approach

    line 18
  2. Distinctive:

    Commit & PR: Write commit messages as Conventional Commits (see CONTRIBUTING.md)

    line 22

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

Scraps Development with Coding Agents

For comprehensive guidelines, see CONTRIBUTING.md

Project Structure

  • Workspace: root crate (src/) + modules/libs/ (scraps_libs)
  • CLI commands: src/cli/cmd/<name>.rs using PathResolver + ScrapConfig
  • Usecases: src/usecase/<name>/usecase.rs
  • IR: src/ir/ (schema, store, loader) persists the compiled wiki under .scraps/ next to .scraps.toml; every command loads scraps through ir::loader
  • Libs features: error, git, lang, markdown, model, search — gated in modules/libs/src/lib.rs
  • Config language: PKL (*.pkl files)
  • Dogfooding: the jaeger MCP server reads the traces of the owner's own Scraps deployment. It is owner-only and called only from the dogfood skill; in any other work, leave mcp__jaeger__* alone
  • Discovery: livt/ is the product discovery workspace (livt); its content is written in Japanese by convention, while the rest of the repository is English

Development Workflow

  1. Plan: Start in Plan mode to analyze requirements and design approach
  2. Implement: One TODO at a time, following TDD (Red -> Green -> Refactor)
    • PostToolUse hook auto-formats .rs files on Edit/Write
    • Pre-commit hook runs cargo:quality (test + fmt + clippy) automatically
  3. Commit & PR: Write commit messages as Conventional Commits (see CONTRIBUTING.md)

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.

Check your setup, free