agentleFS
Sign inStart free
tznctznc/treq/src-tauri/AGENTS.md

treq / src-tauri

AGENTS.md5 starsChanged 19 days agoApache-2.0View on GitHub

Unit tests live inline in a #[cfg(test)] mod tests next to the code. Integration tests against real jj repos live in tests/it/ (one test binary); tests/common/mod.rs provides TestRepo, a real jj repo in a TempDir. scripts/coverage.sh runs the tests under cargo-llvm-cov and writes an HTML report to coverage/html/ (pass a nextest filter to cover one area). The Coverage workflow runs the same after each merge to main and uploads the report as the rust-coverage artifact. Add a Criterion benchmark in…

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. treq-dev/treq★ 5100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

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

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
  1. Very specific:

    Use tempfile::TempDir for any filesystem operations.

    line 13
  2. Very specific:

    Test one behaviour per #[test] function

    line 14
  3. Very specific:

    Use assert_eq! / assert! directly.

    line 16
  4. Very specific:

    Add a Criterion benchmark in benches/ for hot paths (file save, keystroke, large diffs).

    line 24

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

Backend Guide (Rust)

  • GPUI shell (src/gpui_shell/) draws every window; each window's model (gpui_shell/window/) reads and changes state through core/.
  • Commands (src/commands/) hold the app-state glue (PTYs, cloud, remote control) that GPUI and the CLI share; keep them thin and delegate to core/.
  • Core (src/core/) holds all business logic (workspaces, commits, repo, changes, remote, ...).
  • Infrastructure: jj.rs (all Jujutsu calls), db.rs / local_db.rs (SQLite), pty.rs (embedded terminal).
  • Thread safety: AppState (src/lib.rs) wraps shared mutable resources in Mutex.

Rust tests

Unit tests live inline in a #[cfg(test)] mod tests next to the code. Integration tests against real jj repos live in tests/it/ (one test binary); tests/common/mod.rs provides TestRepo, a real jj repo in a TempDir.

  • Use tempfile::TempDir for any filesystem operations; never hardcode paths
  • Test one behaviour per #[test] function
  • Name tests verb_noun_condition: creates_workspace_with_empty_dir, returns_error_when_path_missing
  • Use assert_eq! / assert! directly; avoid custom assertion helpers unless shared across many tests

Coverage

scripts/coverage.sh runs the tests under cargo-llvm-cov and writes an HTML report to coverage/html/ (pass a nextest filter to cover one area). The Coverage workflow runs the same after each merge to main and uploads the report as the rust-coverage artifact.

Benchmarks

Add a Criterion benchmark in benches/ for hot paths (file save, keystroke, large diffs). Use BatchSize::PerIteration with TestRepo to isolate each iteration.

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