chore: add ai agent guidance - #10376
Conversation
|
A few comments:
|
|
|
||
| ## Project ownership | ||
|
|
||
| This repository is the canonical upstream, maintained by the Raspberry Pi Foundation. It |
There was a problem hiding this comment.
Maybe specify "RaspberryPiFoundation/blockly" so that "this repository" doesn't carry over to forks
| is in | ||
| [`packages/blockly/AGENTS.md`](../packages/blockly/AGENTS.md#breaking-changes). | ||
| Use that list rather than a separate one here, so the two cannot drift apart. | ||
| - **Avoid:** Prefer deprecation with migration paths over removal. |
There was a problem hiding this comment.
I'd drop the "avoid" here, as it kind of counteracts the "prefer"
| The Blockly library itself. Source is TypeScript in `core/`; the build runs through Gulp | ||
| and the Closure Compiler. | ||
|
|
||
| Repo-wide conventions (commits, licence headers, naming) are in the |
| - **Block model:** `block.ts` — data model; `block_svg.ts` — SVG rendering and UI | ||
| - **Workspace:** `workspace.ts` — data container; `workspace_svg.ts` — rendered workspace with drag/zoom | ||
| - **Fields:** `field.ts` — base class for all block input fields (text, dropdown, checkbox, etc.) | ||
| - **Connections:** `connection.ts`, `connection_checker.ts`, `connection_db.ts` — typed connection points between blocks |
There was a problem hiding this comment.
rendered_connection.ts might be worth a mention
|
Thanks, I'll fold those suggestions in. re: script commands, claude really seems to want them and I do think explicitly telling it to just run the mocha tests in node for quick verification is better because it does often try to run all of |
|
Sounds good, and yeah agreed on the guidance to just run the node tests most of the time. |
The basics
The details
Resolves
Proposed Changes
.claude/to the gitignore and prettierignoreReason for Changes
Test Coverage
n/a
Documentation
this is that, sort of
Additional Information
Claude generated all these files, I hand-reviewed and made or requested changes where it missed some nuance.
@gonfunko requesting you specifically because i know you had some ideas and i'm not sure if i missed any of them
@zspriggs adding as fyi because this is adjacent to some of the things you're working on, feel free to add feedback