Skip to content

Commit 13f02de

Browse files
docs: expand AGENTS.md with full build, architecture, and convention details
1 parent 96e2381 commit 13f02de

1 file changed

Lines changed: 25 additions & 8 deletions

File tree

AGENTS.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
11
# deadcode
22

3-
Repo guide for agents.
3+
## Purpose
4+
CLI tool to detect and auto-remove unused exports, dead routes, and orphaned CSS in TypeScript/React/Next.js projects.
45

5-
## Workflow
6-
- Use `pytest` for tests.
7-
- Use `ruff` for lint/format.
8-
- Build/publish via GitHub Actions in `.github/workflows/`.
6+
## Build & Test Commands
7+
- Install: `pip install -e .` or `pip install git+https://github.com/Coding-Dev-Tools/deadcode.git`
8+
- Test: `pytest tests/` (or `python -m pytest tests/ -v --tb=short`)
9+
- Lint: `ruff check src/ tests/`
10+
- Format: `ruff format src/ tests/`
11+
- Build: `pip install build twine && python -m build && twine check dist/*`
12+
- CLI check: `deadcode --help`
13+
14+
## Architecture
15+
Key directories:
16+
- `src/deadcode/` — Main package (CLI, scanner, config)
17+
- `tests/` — Test suite
18+
- `.github/workflows/` — CI/CD (auto-code-review.yml, ci.yml, publish.yml)
919

1020
## Conventions
11-
- Package code under `src/deadcode` per `pyproject.toml` packaging config.
12-
- Keep branches `improve/<repo>-<timestamp>` for structural fixes.
13-
- Do not modify dependencies without updating `pyproject.toml`.
21+
- Language: Python 3.10+
22+
- Test framework: pytest (with coverage)
23+
- CI: GitHub Actions (matrix: Python 3.10, 3.11, 3.12, 3.13)
24+
- Linting/formatting: ruff (line-length 120, target py310)
25+
- Package layout: src/ layout with setuptools
26+
- Type checking: py.typed included
27+
- Dependencies: click, rich, pathspec, pyyaml
28+
- CLI entry point: deadcode.cli:cli
29+
- Default branch: master
30+
- Branch naming: `improve/<repo>-<timestamp>` for structural fixes

0 commit comments

Comments
 (0)