AGENTS.md

# AGENTS.md

Guidance for agents and contributors adding a source and cutting a release.
Read this before opening a PR — several recent contributions added data but
skipped the doc/version bump, forcing a maintainer cleanup release.

## How the docs are actually maintained

`src/make_docs.py` is a **scaffolding/assembly helper, not a round-trip source
of truth.** It regenerates the README source table + release totals, `LICENSE`,
a `CHANGELOG` stub, and *template* datasheets — but it does **not** reproduce the
committed docs on its own:

- It iterates `SOURCES` in `src/sources.py`; any source in `data/` but missing
  from `SOURCES` is silently dropped from the table and totals.
- It stamps every regenerated datasheet's "Added" with the single global `ADDED`
  constant, overwriting real per-source add dates.
- It cannot reproduce hand-written README narrative (audit notes, policy notes,
  the phrase-frequency section).

So datasheets and the README narrative are **hand/contributor-maintained**.
Never run `make_docs.py` and commit the result blind — `git diff` first and
restore anything it dropped or restamped.

## Add a source

1. Produce the artifact under `data/<key>/`:
   - `<key>.parquet` — built by `src/build_dynaword.py` (LFS-tracked automatically).
   - `<key>.stats.json` — doc/token/char counts (drives all totals).
   - `<key>.md` — datasheet (see below).
2. Add the ingestion script: `src/fetch_<key>.py` or `src/clean_<key>.py`, so the
   source is reproducible. `build_source` (build_dynaword.py) expects a
   `<file_key|speakleash_key>.jsonl.zst` intermediate.
3. Register the source in `src/sources.py` (`SOURCES`) — required, or make_docs
   never sees it. Copy an existing entry's shape: `pretty`, `license`,
   `license_spdx`, `traceable`, `upstream`, `domain`, `created`, `is_ocr`, and the
   `speakleash_key`/`file_key`. If the datasheet is hand-authored (rich provenance
   or a fixed add date), add `"custom_datasheet": True` so make_docs leaves it
   alone.
4. Add a contract test: `src/test_<key>_contract.py` (canonical schema, non-empty
   text, positive token counts, uniform source/license, stats-file consistency).
   Run `python3 -m pytest src/` before committing.

## Cut the release (the part that gets skipped)

1. In `src/make_docs.py`: bump `VERSION` and `RELEASE_DATE`. Add a row for the new
   version to the version table and a row for yourself to the Contributors table
   (both are literal rows in the template).
2. Regenerate the phrase-frequency report and charts (registry-independent — it
   globs `data/*/*.parquet`):
   ```bash
   python3 src/pattern_frequency_report.py
   ```
   Writes `artifacts/pattern_frequency_hf_snippet.md` + 10 PNGs. Splice the tables
   and chart embeds into the README "Results" section by hand.
3. Update `README.md` by hand: header totals, version table, source table row,
   Contributors row. The document/token totals must equal the sum of the
   per-source `stats.json` files.
4. Prepend the release notes to `CHANGELOG.md` under a new `## vX.Y.Z (date)`
   heading. History is append-only — never rewrite earlier releases.

## Do not commit

`*.log` (fetch/build logs), `.DS_Store`, `src/__pycache__/`. Only `logs/` is in
`.gitignore` — root-level logs and OS cruft are not, so check `git status`
before staging. `*.parquet` is LFS-tracked; commit the pointer, not the blob.

## Known drift / cleanup opportunities

- `biblioteka_nauki`, `europeana`, `parlamint_pl` are in `SOURCES` but have no
  `data/` shard (make_docs skips them with `! no stats`). Intentional placeholders
  or stale — confirm before relying on `build_dynaword.py --all`.
- The global `ADDED` datasheet stamp is a footgun: give datasheets a per-source
  add date (or `custom_datasheet`) before making make_docs regenerate them.