Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ lives under `pyiceberg/`, organized by concern rather than by engine:
- Use domain-specific exceptions from pyiceberg/exceptions.py for Iceberg-specific error conditions. For invalid arguments/values, ValueError is acceptable. Don't raise bare Exception.
- Comments should be succinct and follow the same style of comments found in the rest of the codebase.

### Spec Compliance

- The [Iceberg spec](https://github.com/apache/iceberg/blob/main/format/spec.md) is the source of truth. Check changes to metadata, manifests, schemas, partitioning, transforms, or the commit path against it, and cite the relevant section when behavior is non-obvious.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially make that list larger (include work involving the catalogs?) and maybe even just tell the agents to always look at the Java reference implementation for any changes.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I've broadened the Java bullet so it covers every change, including catalog work. I also added a bullet pointing REST catalog changes (pyiceberg/catalog/rest/) at the REST catalog OpenAPI spec.

- Changes to the REST catalog (`pyiceberg/catalog/rest/`) must follow the [REST catalog OpenAPI spec](https://github.com/apache/iceberg/blob/main/open-api/rest-catalog-open-api.yaml).
- Check every change, including catalog work, against the [Java reference implementation](https://github.com/apache/iceberg). Where the spec is ambiguous or silent, follow Java. Deviations from Java need a justification in the PR.

### Dependencies

- Large/integration libraries must be **optional extras** in `pyproject.toml`, not core `dependencies`.
Expand Down
Loading