-
Notifications
You must be signed in to change notification settings - Fork 146
docs: add agents.md #1292
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
docs: add agents.md #1292
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Pact Python - Quick Reference for AI Agents | ||
|
|
||
| ## Commands | ||
|
|
||
| - **Test**: `hatch run test` (all tests) or call `pytest` directly. | ||
| - **Lint**: `hatch run lint --fix` (check+fix) or `hatch run format` (auto-fix) | ||
| - **Typecheck**: `hatch run typecheck` (all) | ||
| - **Examples**: `hatch run example` (run example tests) | ||
| - **All checks**: `hatch run all` (format, lint, test, typecheck) | ||
| - **V2 tests**: `hatch run v2-test:test` (legacy v2 compatibility tests) | ||
|
|
||
| ## Code Style | ||
|
|
||
| - **Imports**: Use generic types (`Iterable`, `Sequence`, `Mapping`) over concrete (`list`, `dict`). Absolute imports only (no relative). | ||
| - **Types**: All functions require type annotations. Use `typing` module for generics. | ||
| - **Docstrings**: Google-style with Markdown formatting. Link references: `[ClassName.method][pact.module.ClassName.method]` | ||
| - **Formatting**: Use `ruff` for linting/formatting. | ||
| - **Naming**: Follow PEP 8. Use descriptive names that indicate purpose. | ||
| - **Error handling**: Use built-in exceptions (`ValueError`, `TypeError`) for standard errors. Custom exceptions inherit from `PactError`. | ||
JP-Ellis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - **Validation**: Use early returns to reduce nesting. | ||
| - **Comments**: Explain design decisions, not what code does. No comments unless necessary. | ||
|
|
||
| ## Testing | ||
|
|
||
| - **Framework**: `pytest` with files prefixed `test_`. Use `@pytest.mark.parametrize` for multiple scenarios. | ||
| - **Coverage**: Focus on critical paths, edge cases, error conditions. | ||
| - **Fixtures**: Use pytest fixtures for shared setup. Minimize mocking. | ||
|
|
||
| ## Project Structure | ||
|
|
||
| - `src/pact/`: Main V3+ codebase (active development) | ||
| - `src/pact/v2/`: Legacy V2 code (maintenance only - no new features) | ||
| - `pact-python-ffi/`: Low-level FFI bindings (memory management, type conversion only) | ||
| - `pact-python-cli/`: CLI wrapper (bundled binaries with system fallback) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.