-
Notifications
You must be signed in to change notification settings - Fork 137
Add CLAUDE.md with development guidance #615
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
RonnyPfannschmidt
merged 1 commit into
pytest-dev:main
from
RonnyPfannschmidt:docs/add-claude-guidance
Nov 28, 2025
Merged
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,11 @@ | ||
| { | ||
| "permissions": { | ||
| "allow": [ | ||
| "Bash(uv run pytest:*)", | ||
| "Bash(uv run mypy:*)", | ||
| "Bash(uv run pre-commit:*)" | ||
|
|
||
| ], | ||
| "deny": [] | ||
| } | ||
| } | ||
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,3 @@ | ||
| # AGENTS.md | ||
|
|
||
| See @CLAUDE.md for AI coding agent instructions. |
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,51 @@ | ||
| # CLAUDE.md | ||
RonnyPfannschmidt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| This file provides guidance to AI coding agents when working with code in this repository. | ||
|
|
||
| ## Project Overview | ||
|
|
||
| Pluggy is a minimalist production-ready plugin system that serves as the core framework for pytest, datasette and devpi. | ||
| It provides hook specification and implementation mechanisms through a plugin manager system. | ||
|
|
||
| ## Development Commands | ||
|
|
||
| All commands use `uv run` for consistent environments. | ||
|
|
||
| ### Testing | ||
| - `uv run pytest` - Run all tests (prefer running all tests for quick feedback) | ||
| - `uv run pytest testing/benchmark.py` - Run benchmark tests | ||
|
|
||
| ### Code Quality | ||
| - `uv run pre-commit run -a` - Run all pre-commit hooks (linting, formatting, type checking) | ||
| - Always reread files modified by pre-commit | ||
|
|
||
| ## Development Process | ||
|
|
||
| - Always read `src/pluggy/*.py` to get a full picture | ||
| - Consider backward compatibility | ||
| - Always run all tests: `uv run pytest` | ||
| - Always run pre-commit before committing: `uv run pre-commit run -a` | ||
| - Prefer running full pre-commit over individual tools (ruff/mypy) | ||
|
|
||
|
|
||
|
|
||
| ## Core Architecture | ||
|
|
||
| ### Main Components | ||
|
|
||
| - **PluginManager** (`src/pluggy/_manager.py`): Central registry that manages plugins and coordinates hook calls | ||
| - **HookCaller** (`src/pluggy/_hooks.py`): Executes hook implementations with proper argument binding | ||
| - **HookImpl/HookSpec** (`src/pluggy/_hooks.py`): Represent hook implementations and specifications | ||
| - **Result** (`src/pluggy/_result.py`): Handles hook call results and exception propagation | ||
| - **Multicall** (`src/pluggy/_callers.py`): Core execution engine for calling multiple hook implementations | ||
|
|
||
| ### Package Structure | ||
| - `src/pluggy/` - Main package source | ||
| - `testing/` - Test suite using pytest | ||
| - `docs/` - Sphinx documentation and examples | ||
| - `changelog/` - Towncrier fragments for changelog generation | ||
|
|
||
| ## Configuration Files | ||
| - `pyproject.toml` - Project metadata, build system, tool configuration (ruff, mypy, setuptools-scm) | ||
| - `tox.ini` - Multi-environment testing configuration | ||
| - `.pre-commit-config.yaml` - Code quality automation (ruff, mypy, flake8, etc.) | ||
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.