From 5d947ca3bb148da32612bc057f418d35884db1b1 Mon Sep 17 00:00:00 2001 From: Aly Raffauf Date: Sun, 26 Jul 2026 00:18:07 -0400 Subject: [PATCH] contributing: document generated code workflow for tangledlex --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c869971..836a7d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,6 +72,15 @@ needed. - `tangled/` — Typed client for the Bobbin API (`api.tangled.org`) - `atproto/` — Identity resolution (handle ↔ DID, PDS discovery); OAuth session storage (system keyring) +## Generated code + +`internal/tangledlex/` is generated from the Tangled lexicons. Do not edit the +`.go` files in that package by hand or via PR; they are produced by +`internal/tangledlex/generate-lexicons.sh` and carry `// Code generated ...` +headers. To add or update lexicons, modify `schemas.txt` (and the CBOR generator +list in `cborgen/main.go` if needed) and run the update script. See +`internal/tangledlex/README.md` for the full workflow. + ## Dependencies - Go 1.26+ -- 2.51.2