Commit 55b4ab48 authored by Jan Reimes's avatar Jan Reimes
Browse files

📝 docs: update AGENTS.md with guidelines for test organization and file structure

parent f65a273b
Loading
Loading
Loading
Loading
+2 −0
Original line number Diff line number Diff line
@@ -355,6 +355,8 @@ For `src/tdoc_crawler/cli/AGENTS.md`, the focus should be on:
### Review and Updates

After several implementation steps, AGENTS.md files might need updates. When explicitly asked:

1. Review the current state using `docs/REVIEW_AND_IMPROVEMENTS_AGENTS_MD.md`
2. Propose changes based on accumulated knowledge
3. Update only after explicit user confirmation
4. For any AGENTS.md files in the project structure, you MUST NEVER add a tree view of files or directories. This changes too often, and coding agents can easily retrieve the project's file structure using `ls` or `tree` commands when needed. AGENTS.md should focus on guidelines and patterns, not on file listings.
+0 −28
Original line number Diff line number Diff line
@@ -2,26 +2,6 @@

This document provides guidance for organizing and extending tests in the TDoc-Crawler project.

## Test Directory Structure

```
tests/
├── AGENTS.md                    # This file
├── conftest.py                  # Shared pytest fixtures
├── pool_executor/               # Pool executor tests
│   ├── __init__.py
│   ├── test_executor_adapter.py # Runner adapter tests
│   └── test_serial_executor.py  # SerialPoolExecutor tests
├── test_cli.py
├── test_crawler.py
├── test_database.py
├── test_http_client.py
├── test_meeting_document_list.py
├── test_models.py
├── test_portal_auth.py
└── test_targeted_fetch.py
```

## Pool Executor Tests (`tests/pool_executor/`)

The `pool_executor/` directory contains all tests related to the `pool_executors` package, which provides executor pool extensions including serial execution support.
@@ -92,14 +72,6 @@ Use package-level imports:
from pool_executors.pool_executors import SerialPoolExecutor, create_executor
```

### Other Tests

Use project imports:

```python
from tdoc_crawler.crawlers.executor_adapter import Runner
from tdoc_crawler.models.tdocs import TDocMetadata
```

## Best Practices