Skip to content

Commit fcec687

Browse files
docs: add AGENTS.md with project conventions
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 3dcb3a6 commit fcec687

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# AGENTS.md
2+
3+
Python SDK for the Captcha Solver API, published on PyPI as `captcha-sdk`.
4+
5+
## Project layout
6+
7+
- `captcha_sdk/` — package: `client.py` (sync), `async_client.py` (async), `tasks.py`, `exceptions.py`
8+
- `tests/sync/`, `tests/async/` — pytest, HTTP is mocked
9+
- `examples/sync/`, `examples/async/` — runnable examples
10+
- `DEVELOPMENT.md` — setup, tests, release process
11+
12+
## Commands
13+
14+
```bash
15+
python -m pip install -e ".[dev]" # required: async tests need pytest-asyncio
16+
python -m pytest -q
17+
python -m build && python -m twine check --strict dist/*
18+
```
19+
20+
## Rules
21+
22+
- The version is defined in two places and must match: `pyproject.toml` (`version`) and `captcha_sdk/__init__.py` (`__version__`).
23+
- Supported Python is 3.9+; do not use syntax or stdlib features newer than 3.9.
24+
25+
## Commits
26+
27+
English, [Conventional Commits](https://www.conventionalcommits.org/) format:
28+
29+
```
30+
<type>: <short description in imperative mood>
31+
```
32+
33+
Types: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`, `ci`, `build`.
34+
35+
Examples:
36+
37+
```
38+
feat: add Tencent captcha task
39+
fix: handle empty solution in async client
40+
docs: add DEVELOPMENT.md
41+
chore: set version to 1.0.0
42+
```

0 commit comments

Comments
 (0)