agentleFS
Sign inStart free
JustLookAtNowJustLookAtNow/pt_mate/AGENTS.md

pt_mate

AGENTS.md512 starsChanged 5 months agoMITView on GitHub

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

8 rules. About 0 are common, 3 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

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

    Follow analysis_options.yaml (flutter_lints).

    line 23
  2. Very specific:

    Use Dart formatting defaults (dart format .): 2-space indentation, trailing commas where helpful.

    line 24
  3. Very specific:

    Keep feature code grouped by domain (for example, adapter logic under lib/services/api/).

    line 26
  4. Distinctive:

    Add or update tests for behavior changes in adapters, parsing, storage, and widgets.

    line 31
  5. Distinctive:

    Run both app and server tests before opening a PR when touching both modules.

    line 32
  6. Distinctive:

    No fixed coverage gate is enforced.

    line 33
  7. Very specific:

    Use Conventional Commit-style prefixes seen in history: feat:, fix:, refactor:, chore:, release:.

    line 36
  8. Very specific:

    Keep commits focused and descriptive (example: feat: add Unit3D category mapping).

    line 37

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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

Repository Guidelines

Project Structure & Module Organization

This repository contains a Flutter client and a small Go backend.

  • lib/: Flutter app code (pages/, services/, providers/, widgets/, models/).
  • test/: Dart/Flutter tests, including widget and service tests (*_test.dart).
  • assets/: app assets and site definitions (assets/sites/ + generated assets/sites_manifest.json).
  • server/: Go API service (main.go, cmd/, migrations/, admin/).
  • Platform folders: android/, ios/, linux/, macos/, windows/, web/.

Build, Test, and Development Commands

  • flutter pub get: install Flutter dependencies.
  • flutter run: run app in debug mode.
  • flutter build apk --release: build Android release APK.
  • flutter analyze: run static analysis with configured lints.
  • flutter test: run all Flutter tests.
  • ./generate_sites_manifest.sh: regenerate site manifest after editing assets/sites/*.
  • cd server && go run .: run backend locally.
  • cd server && go test ./...: run backend tests.

Coding Style & Naming Conventions

  • Follow analysis_options.yaml (flutter_lints); keep analyzer warnings at zero.
  • Use Dart formatting defaults (dart format .): 2-space indentation, trailing commas where helpful.
  • File names: snake_case.dart; classes/enums: PascalCase; methods/variables: camelCase.
  • Keep feature code grouped by domain (for example, adapter logic under lib/services/api/).

Testing Guidelines

  • Flutter tests use flutter_test; backend uses Go’s built-in testing package.
  • Name tests with *_test.dart and *_test.go.
  • Add or update tests for behavior changes in adapters, parsing, storage, and widgets.
  • Run both app and server tests before opening a PR when touching both modules.
  • No fixed coverage gate is enforced; prioritize meaningful assertions for changed paths.

Commit & Pull Request Guidelines

  • Use Conventional Commit-style prefixes seen in history: feat:, fix:, refactor:, chore:, release:.
  • Keep commits focused and descriptive (example: feat: add Unit3D category mapping).
  • PRs should include:
    • clear summary of behavior changes,
    • linked issue/PR number when applicable (for example #93),
    • screenshots/GIFs for UI changes,
    • notes for config/data updates (especially assets/sites/ and manifest regeneration).

Download now (ZIP)

  • 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 28,693 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 repository5 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

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