mirror of
https://github.com/PlaneQuery/OpenAirframes.git
synced 2026-09-20 12:52:15 +02:00
docs: cut AGENTS.md back to operative constraints
- drop narrative rationale, restated rules and background a reader can grep for - one rule per line; the file is read by a model about to act, not by a person catching up - 151 lines to 85 Generated-by: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Ashley Childress
@@ -1,150 +1,82 @@
|
|||||||
## Never interpolate `${{ github.event.* }}` into a `run:` block
|
## Never interpolate `${{ github.event.* }}` or `${{ inputs.* }}` into a `run:` block
|
||||||
|
|
||||||
Actions substitutes `${{ }}` as raw text before the shell parses it, and issue bodies here are
|
Pass them via `env:` and quote the shell variable. A quoted heredoc does not help — the body can
|
||||||
public and unauthenticated. Pass untrusted values through `env:` and quote them.
|
contain the delimiter and close it early. Never fix this by escaping or renaming the delimiter.
|
||||||
|
|
||||||
A quoted heredoc delimiter does not save you: the body can *contain* the delimiter, close the
|
## Invocation
|
||||||
heredoc early, and execute every line after it. `validate-community-submission.yaml` had that shape.
|
|
||||||
Never fix this class of bug by escaping, sanitizing, or renaming the delimiter — move it to `env:`.
|
|
||||||
|
|
||||||
## Run everything from the repo root
|
- `src/*.py` at the root of `src/` are scripts: `python src/create_daily_faa_release.py`. Bare
|
||||||
|
sibling imports, so `-m` raises `ModuleNotFoundError`.
|
||||||
`src/create_daily_faa_release.py` and `src/create_daily_tc_release.py` must be invoked as **scripts**
|
- `src/adsb/*`, `src/contributions/*` are packages: `python -m`.
|
||||||
(`python src/create_daily_faa_release.py`). They use bare sibling imports, so `-m` raises
|
- Run from the repo root; output paths are CWD-relative.
|
||||||
`ModuleNotFoundError`.
|
|
||||||
Everything under `src/adsb/` and `src/contributions/` is the opposite — `python -m`, package-relative.
|
|
||||||
|
|
||||||
Output paths are CWD-relative.
|
|
||||||
|
|
||||||
## Verification
|
## Verification
|
||||||
|
|
||||||
There is no test framework, linter, or packaging config. **Do not add one unprompted**, and do not
|
- No test framework, linter, or packaging config. Do not add one unprompted.
|
||||||
treat "nothing broke" as verification.
|
- Never `gh workflow run` to test a change — every dispatch pulls tens of GB.
|
||||||
|
- Never commit generated data. The product is a GitHub Release; jobs pass state as artifacts.
|
||||||
|
- ADS-B has no cheap end-to-end check. Exercise `compress_multi_icao_df` on a hand-built frame.
|
||||||
|
|
||||||
The ADS-B path has no cheap end-to-end check — one day of input is tens of GB. Exercise
|
## Release invariants
|
||||||
`compress_multi_icao_df` / `compress_df_polars` directly against a small hand-built Polars frame.
|
|
||||||
|
|
||||||
**Never `gh workflow run` to test a change.** Every dispatch pulls tens of GB and fans out over date
|
- `FINAL_COLUMN_ORDER` (`compress_adsb_to_aircraft_data.py`) is the only definition of the ADS-B
|
||||||
matrices. Reason about the YAML statically.
|
column contract. `pl.concat` matches by position after `.select()`; a forked copy corrupts the
|
||||||
|
release with no error.
|
||||||
|
- Empty string, never null, in every released frame.
|
||||||
|
- `openairframes_id` = `normalize(manufacturer)|normalize(model)|normalize(serial)`. Reuse
|
||||||
|
`derive_from_faa_master_txt.normalize()`.
|
||||||
|
- Each source's daily build reads its own previous release asset and appends. Falling back to a
|
||||||
|
single-day rebuild on anything but `FileNotFoundError` republishes one day as the whole dataset,
|
||||||
|
which the next run then reads back as its base. Keep the fallback narrow.
|
||||||
|
- Python `3.14` for FAA/community/vendor jobs, `3.12` for ADS-B. Match the surrounding job.
|
||||||
|
|
||||||
**Never commit generated data.** The product is a GitHub Release; jobs pass state as artifacts.
|
## Registry sources
|
||||||
|
|
||||||
## ADS-B invariants
|
- Judge **redistribution**, not access. A public licence travels to this project; a bilateral
|
||||||
|
permission granted to another project does not — that alone disqualifies Taiwan, Estonia, Chile.
|
||||||
|
Non-commercial-only terms are a separate, independent bar.
|
||||||
|
- `NOTICE` carries the terms that make each asset redistributable and is a required release file.
|
||||||
|
Never edit or drop an entry. Transport Canada requires both its notices together.
|
||||||
|
- `LICENSE` is MIT and covers code only. Claim nothing about released data.
|
||||||
|
- Owner/registrant mailing addresses are published for every registry. FAA and TC must not diverge.
|
||||||
|
- CCARCS `ACTIVE_FLAG` is not "current owner": 1,932 Registered marks carry only `I` parties, and
|
||||||
|
those rows are the `MAIL_RECIPIENT`. Prefer `A`, fall back to all.
|
||||||
|
- CCARCS addresses come from the single `MAIL_RECIPIENT == "Y"` row, never merged across co-owners.
|
||||||
|
|
||||||
- `FINAL_COLUMN_ORDER` (`compress_adsb_to_aircraft_data.py`) is the only definition of the released
|
## ADS-B
|
||||||
column contract. `pl.concat` matches by **position** after `.select()`, and
|
|
||||||
`get_latest_release.get_latest_aircraft_adsb_csv_df` parses released CSVs against the same order —
|
|
||||||
so a forked copy corrupts the release with no error anywhere.
|
|
||||||
- `load_parquet_part()` deleting its source parquet is **deliberate**: the raw part is many GB and
|
|
||||||
the runner would otherwise exhaust disk. Do not defer the delete to make reruns easier; that raises
|
|
||||||
peak disk by the size of the part.
|
|
||||||
- A released row means "most informative observation for this ICAO on this UTC day" — non-empty
|
|
||||||
fields not a subset of another row's, tie-broken by signature frequency. It is not a registry record.
|
|
||||||
- HTTP 404 is terminal in the release fetch. Restoring the retry makes the Dec-31 next-year-repo
|
|
||||||
probe stall ~45 minutes on a repo that does not exist yet.
|
|
||||||
|
|
||||||
## Never edit or drop a `NOTICE` entry
|
- `load_parquet_part()` deleting its source parquet is deliberate — disk pressure. Do not defer it.
|
||||||
|
- A released row is the most informative observation for that ICAO on that UTC day, not a registry
|
||||||
Each entry is the permission that makes its asset redistributable; removing one removes the
|
record.
|
||||||
permission. `NOTICE` is validated as a **required** release file and is listed in the
|
- HTTP 404 is terminal in the release fetch; restoring the retry stalls the Dec-31 probe ~45 min.
|
||||||
`create-release` sparse checkout — keep both. Transport Canada requires its two notices,
|
|
||||||
reproduction and value-added, to reach the consumer together.
|
|
||||||
|
|
||||||
`LICENSE` is MIT and covers **code only**. It makes no claim over released data, and neither may
|
|
||||||
you — an asset derived from a public-domain source is not itself public domain.
|
|
||||||
|
|
||||||
Before adding any registry, judge redistribution, not access, in this order:
|
|
||||||
|
|
||||||
1. **A public licence travels; a bilateral permission does not.** Written permission granted to
|
|
||||||
another project or person is not a licence to this one. That alone disqualifies Taiwan, Estonia
|
|
||||||
and Chile, whatever their commercial terms say.
|
|
||||||
2. **Non-commercial-only conditions are a second, independent bar** — they conflict with how these
|
|
||||||
releases are consumed. Do not treat a source clearing this bar as cleared overall; rule 1 still
|
|
||||||
applies. Taiwan is licensed OGDL v1.0, an open licence: its restriction is bilateral, not licence-borne.
|
|
||||||
|
|
||||||
CCARCS `ACTIVE_FLAG` does **not** mean "current owner": 1,932 currently-Registered marks carry only
|
|
||||||
`I` parties, and those rows are the `MAIL_RECIPIENT`. Prefer `A` parties where a mark has any, fall
|
|
||||||
back to all of them otherwise. Filtering on `A` alone publishes registered aircraft with no owner.
|
|
||||||
|
|
||||||
Owner mailing addresses **are** published, matching the `registrant_*` address the FAA asset already
|
|
||||||
carries — the two sources must not diverge on this. Addresses are per-party, so they come from the
|
|
||||||
single `MAIL_RECIPIENT == "Y"` row (exactly one per mark) and are never merged across co-owners; only
|
|
||||||
name, type, province and country are merged lists.
|
|
||||||
|
|
||||||
## Fork and upstream
|
|
||||||
|
|
||||||
`src/get_latest_release.py` pins `REPO = "PlaneQuery/openairframes"` on purpose: this fork reads
|
|
||||||
**upstream's** releases wherever it runs. Do not repoint it at `github.repository` without being asked.
|
|
||||||
|
|
||||||
Upstream develops on `develop` and PRs into `main`. The daily release **deletes the existing release
|
|
||||||
and tag** before recreating them.
|
|
||||||
|
|
||||||
## Community submissions are automation-owned
|
## Community submissions are automation-owned
|
||||||
|
|
||||||
Merging to `community/**` or `schemas/**` force-pushes every open `community`-labeled PR branch back
|
- Merging `community/**` or `schemas/**` force-pushes every open `community` PR branch onto main.
|
||||||
onto main. Anything you hand-edit on such a branch is destroyed on the next merge.
|
Hand edits there are destroyed.
|
||||||
|
- Never hand-author `community/` files — the filename encodes `sha256(content)[:8]`.
|
||||||
|
- A tag's JSON type is fixed by its first submission and enforced forever. Emergent from
|
||||||
|
`build_tag_type_registry` + `validate_submission`; written nowhere in the schema.
|
||||||
|
- Adding `community_submission.v2.schema.json` promotes it atomically across every reader and
|
||||||
|
writer. One-way door — only on request.
|
||||||
|
|
||||||
- Never hand-author files in `community/` — the filename encodes `sha256(content)[:8]`, so an edit
|
## Fork
|
||||||
orphans the hash and duplicates on re-approval.
|
|
||||||
- Never invent or copy a `contributor_uuid`; it is derived from the GitHub user id.
|
|
||||||
- Do not reintroduce a hardcoded `"main"` or `v1` filename. Both are resolved at runtime now.
|
|
||||||
|
|
||||||
**A tag's JSON type is fixed by its first-ever submission and enforced forever** — emergent from
|
`get_latest_release.REPO` pins upstream `PlaneQuery/openairframes` on purpose. Do not repoint it.
|
||||||
`build_tag_type_registry` + `validate_submission`, and written nowhere in the schema. Retyping or
|
Upstream develops on `develop`. The daily release deletes the existing release and tag first.
|
||||||
renaming an existing tag breaks every future contributor, not just the current one.
|
|
||||||
|
|
||||||
Dropping a `community_submission.v2.schema.json` into `schemas/` promotes it atomically across every
|
## Do not chase
|
||||||
reader and writer. That is a one-way door for contributors — only on explicit request.
|
|
||||||
|
|
||||||
## Conventions
|
- `process-historical-faa.yaml` is dead: missing `src/get_historical_faa.py`,
|
||||||
|
`scripts/concat_csvs.py`, and uses the disabled `::set-output`.
|
||||||
|
- `af-klm-fleet/package.json` → `npm run validate` has no `scripts/validate.js`.
|
||||||
|
- `af-klm-fleet/` and `community-routes/` are unwired; nothing in CI touches them.
|
||||||
|
`af-klm-fleet/README.md` is generated.
|
||||||
|
|
||||||
- **Empty string, not null**, everywhere in released frames.
|
## Flag, do not silently fix
|
||||||
- Reuse `derive_from_faa_master_txt.normalize()` for `openairframes_id`; never re-derive the format.
|
|
||||||
- Python `3.14` for FAA/community/vendor jobs, `3.12` for ADS-B jobs (pyarrow pin + multiprocessing).
|
|
||||||
Deliberate. Match the surrounding job; do not unify.
|
|
||||||
|
|
||||||
## References with no target — do not chase as regressions
|
- `NUMBER_PARTS` is restated by the matrix and four upload steps in `adsb-to-aircraft-for-day.yaml`.
|
||||||
|
- `MAX_WORKERS = ... if OS_CPU_COUNT > 4 else 1` collapses to one worker on a ≤4-core runner.
|
||||||
| Reference | Missing |
|
- `update-community-prs.yaml` runs `regenerate_pr_schema || true`, then force-pushes.
|
||||||
|---|---|
|
- `approve_submission.py` wraps its schema update in a bare `except Exception`.
|
||||||
| `process-historical-faa.yaml` | `src/get_historical_faa.py`, `scripts/concat_csvs.py` |
|
- Existing workflows violate the global GHA rules. Fix only the file you were asked to touch.
|
||||||
| `af-klm-fleet/package.json` → `npm run validate` | `af-klm-fleet/scripts/validate.js` |
|
|
||||||
|
|
||||||
`process-historical-faa.yaml` is dead, not stale — it also uses the disabled `::set-output`.
|
|
||||||
Repair-vs-delete is the owner's call; leave it alone unprompted.
|
|
||||||
|
|
||||||
## `af-klm-fleet/` and `community-routes/` are unwired
|
|
||||||
|
|
||||||
Nothing in CI touches either, and nothing consumes `community-routes/`. `af-klm-fleet/` is a vendored
|
|
||||||
project by a different author with its own license — its aircraft model is unrelated to
|
|
||||||
`schemas/community_submission.*`, so do not merge the two. Its `README.md` is generated by
|
|
||||||
`generate-readme.js`; hand edits are overwritten.
|
|
||||||
|
|
||||||
## Warts left standing — flag, do not silently fix
|
|
||||||
|
|
||||||
- `NUMBER_PARTS` is restated by the matrix and four hand-written upload steps in
|
|
||||||
`adsb-to-aircraft-for-day.yaml`; changing the constant alone silently drops data. YAML cannot loop
|
|
||||||
upload steps and one merged artifact would force every map job to download all parts, so any real
|
|
||||||
fix is a restructure.
|
|
||||||
- `MAX_WORKERS = OS_CPU_COUNT if OS_CPU_COUNT > 4 else 1` collapses to a single worker on a ≤4-core
|
|
||||||
runner, shrinking `files_per_batch` with it. Possibly intentional memory control — do not raise it
|
|
||||||
without measuring peak RSS on the target runner.
|
|
||||||
- `update-community-prs.yaml` runs `regenerate_pr_schema || true` then force-pushes, so a
|
|
||||||
regeneration failure ships anyway. Making it fatal leaves PRs un-rebased instead — a judgment call.
|
|
||||||
- `approve_submission.py` wraps its schema update in a bare `except Exception`, so a submission can
|
|
||||||
merge without its new tags reaching the schema.
|
|
||||||
|
|
||||||
## Workflow authoring
|
|
||||||
|
|
||||||
The user's global GitHub Actions rules apply. Existing workflows violate most of them.
|
|
||||||
**Do not bulk-remediate** — bring only the file you were asked to touch up to standard, and surface
|
|
||||||
the rest in chat.
|
|
||||||
|
|
||||||
## External sources
|
|
||||||
|
|
||||||
`registry.faa.gov` and ADS-B Exchange are **required** — the release fails without them. Mictronics is
|
|
||||||
**tolerated**: it retries, then the job continues without it. adsb.lol may simply not have published a
|
|
||||||
given day, in which case the previous CSV is re-released rather than failing.
|
|
||||||
|
|
||||||
FAA refreshes at 05:30 UTC; the release cron fires at 06:00 UTC. That 30-minute margin is the reason
|
|
||||||
for the schedule.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user