Commit 6dcfc923 authored by Jan Reimes's avatar Jan Reimes
Browse files

docs(agents): update AGENTS.md files with additional context

* Enhance CLI AGENTS.md with a description of code conventions and patterns.
* Add context to test AGENTS.md regarding test conventions and requirements.
parent e6238e8d
Loading
Loading
Loading
Loading
+5 −7
Original line number Diff line number Diff line
@@ -225,13 +225,11 @@ Avoid using `typing.TYPE_CHECKING` at all costs! When used for just for type ann

## Scoped AGENTS.md (MUST read when working in these directories)

| Directory | Purpose |
|-----------|---------|
| `src/tdoc_crawler/` | Import patterns, HTTP caching, anti-duplication |
| `src/tdoc_crawler/cli/` | CLI patterns |
| `packages/3gpp-ai/` | AI pipeline, embeddings, graph patterns |
| `packages/convert-lo/` | LibreOffice conversion |
| `tests/` | Testing patterns, fixtures, coverage |
List scoped AGENTS.md files with:

```shell
rg -l "" -g "*/**/AGENTS.md"
```

> **Agents:** When editing files in listed directories, load its AGENTS.md first. It contains directory-specific conventions that override this root file.

+2 −0
Original line number Diff line number Diff line
# CLI Submodule Guidelines

CLI-only code conventions, classification rules, and Typer/Rich patterns for the `tdoc_crawler` CLI.

## Design Principle

The `cli/` submodule contains **only CLI-related functionality**. The core `tdoc_crawler` package is a standalone library. Think of `cli/` as an optional extras package.
+2 −0
Original line number Diff line number Diff line
# Test Organization Guidelines

Test conventions, fixtures, mocking patterns, and coverage requirements for the 3GPP Crawler test suite.

## Quick Start

1. **General TDD patterns**: Use the `test-driven-development` skill for pytest, mocking, fixtures, and coverage