agentleFS
datafusion-contribdatafusion-contrib/datafusion-distributed/iceberg/AGENTS.md

datafusion-distributed / iceberg

AGENTS.md172 starsChanged 9 days agoApache-2.0View on GitHub

- Use IcebergTestHarness from datafusion-distributed-iceberg-test-tools for integration-test session, codec, and worker setup. It doesn't depend on this crate, so each test installs the integration with with_session_extension(|state| state.with_iceberg_integration(..)), sets Iceberg options by name with with_config_option("iceberg.*", ..), builds its table with the test tools, e.g. create_taxi_table(), and hands it over with with_table(..); without one, the harness has no table. Use with_metadata to serve customized metadata for that table. - Never add with_x_and_y, with_x_with_y, or equivalent constructor or registration variants. Add settings to…

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

The file

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

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

  • 5

    Very specific

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

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

    Use IcebergTestHarness from datafusion-distributed-iceberg-test-tools for integration-test session, codec, and worker setup.

    line 5
  2. Very specific:

    Never add with_x_and_y, with_x_with_y, or equivalent constructor or registration variants.

    line 13
  3. Very specific:

    Use configure_session for coordinator-only session configuration and with_workers for distributed execution.

    line 18
  4. Very specific:

    Prefer integration tests over unit tests when possible.

    line 30
  5. Very specific:

    Keep relevant harness configuration and compact inline insta snapshots in each test.

    line 36

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

Iceberg crate guide

Tests

  • Use IcebergTestHarness from datafusion-distributed-iceberg-test-tools for integration-test session, codec, and worker setup. It doesn't depend on this crate, so each test installs the integration with with_session_extension(|state| state.with_iceberg_integration(..)), sets Iceberg options by name with with_config_option("iceberg.*", ..), builds its table with the test tools, e.g. create_taxi_table(), and hands it over with with_table(..); without one, the harness has no table. Use with_metadata to serve customized metadata for that table.
  • Never add with_x_and_y, with_x_with_y, or equivalent constructor or registration variants. Add settings to IcebergIntegrationOptions or use existing composable builder methods. Register custom codecs through with_session_extension and IcebergIntegrationOptions::file_io_codec, so the harness installs them on both the coordinator and workers.
  • Use configure_session for coordinator-only session configuration and with_workers for distributed execution. Keep these choices in the test's builder chain; do not construct replacement sessions or workers by hand.
  • Build any other table with datafusion-distributed-iceberg-test-tools (test-tools/) rather than by hand or by committing data files. A FixtureCatalog is an in-memory catalog over a temp dir. fixtures.table(ident, schema).partition_by(..).create() creates a table, and each table.append().file(batch)...commit() adds one snapshot in which every batch becomes exactly one data file. Snapshot ids count up from 1, so snapshots can show them. create_taxi_table generates a deterministic, synthetic stand-in for NYC taxi trips: 7 days × 25,000 rows, identity-partitioned on pickup_date, one file per day.
  • Prefer integration tests over unit tests when possible. Each isolated feature should have its own dedicated file in tests/.
  • Tests are executable documentation. A reviewer should understand the scenario, configuration, operation, and expected behavior by reading the test itself. Optimize for that understanding, not for the fewest lines. Follow the repository test-design rules.
  • Keep relevant harness configuration and compact inline insta snapshots in each test. Helpers below the tests should handle fixture mechanics, not hide the scenario or its assertions.

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.