Skip to content

Commit 67a910d

Browse files
committed
Address PR feedback
1 parent 41e91c8 commit 67a910d

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

.agents/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Trace modules, the schema, and where a change lands. [CONTRIBUTING.md](../CONTRI
66

77
A trace module is a plain object with functions attached, exported from `src/traces/<name>/index.js` and registered through the registry. The figure-wide subroutines call the methods in a loop, so the subroutines work with whatever set of trace modules a bundle registers.
88

9-
The methods you touch most:
9+
The methods/properties you touch most:
1010

1111
- `attributes` - the JSON-serializable attribute declarations that feed the schema
1212
- `supplyDefaults` - input settings to `gd._fullData`. Cheap. No data loops.
@@ -18,7 +18,7 @@ Read the "Trace module design" section of [CONTRIBUTING.md](../CONTRIBUTING.md)
1818

1919
## The schema
2020

21-
`test/plot-schema.json` is generated output that records the proposed API. Any change to an attribute or an attribute description changes this file.
21+
`test/plot-schema.json` is generated output that captures the full plotly.js API. Any change to an attribute or an attribute description changes this file.
2222

2323
```bash
2424
npm run schema

.agents/code-style.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Formatting
66

7-
Biome owns formatting. The JavaScript rules live in `biome.json`: single quotes, a four-space indent, no trailing commas, and a 120 column line width.
7+
Biome owns formatting. The JavaScript rules live in `biome.json`.
88

99
Run the formatter on every file you add:
1010

@@ -14,7 +14,7 @@ npx @biomejs/biome format --write <path>
1414

1515
Format only files you created. Never pass a directory, and never format a file that already existed. The CLI formats a whole file at a time, and this repository is not formatted from end to end, so either one rewrites lines your change never touched and buries the real diff.
1616

17-
In an existing file, write the lines you add by hand, to the settings above. That means single quotes, a four-space indent, no trailing comma, and no line past 120 columns. The settings are the house style, so follow them even when the lines around yours predate them. If you formatted such a file by accident, undo your changes and redo the edit.
17+
In an existing file, write the lines you add by hand, to follow the rules outlined in `biome.json`. The settings are the house style, so follow them even when the lines around yours predate them. If you formatted such a file by accident, undo your changes and redo the edit.
1818

1919
`npm run lint-fix` also writes. It formats `test/image/mocks` and applies the safe lint fixes across every included path, so run it only when you want both.
2020

.agents/pr-checklist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Walk this list before you hand the work back. Answer each item with evidence, no
88
- [ ] A human asked for the pull request. If nobody asked, you open the issue and stop.
99
- [ ] A human reviewed the code
1010
- [ ] You saw the rendered plot, for any change that moves pixels
11-
- [ ] You read the last few merged pull requests and matched their shape
11+
- [ ] You read the last few merged pull requests by library maintainers and matched their shape
1212

1313
## The change
1414

@@ -26,7 +26,7 @@ Walk this list before you hand the work back. Answer each item with evidence, no
2626
## Generated output
2727

2828
- [ ] `npm run schema` ran after any attribute or description edit
29-
- [ ] `test/plot-schema.json` and `src/types/generated/schema.d.ts` are staged
29+
- [ ] `test/plot-schema.json` and `src/types/generated/schema.d.ts` are committed if they changed
3030
- [ ] `npm run schema-typegen-diff-check` reports no drift
3131
- [ ] The hand-written declarations under `src/types/core/` and `src/types/lib/` match the new API surface
3232
- [ ] Regl shaders regenerated, if the diff touches a regl path

.agents/testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ npm run test-jasmine -- axes --nowatch
5050

5151
`--nowatch` turns off the watch mode, so the run exits after one pass instead of waiting for the next file change. Pass the exact file basename without the `_test.js` suffix, which the karma config appends for you. The name is not a substring: `-- bar` runs `bar_test.js` alone, and a partial name such as `hover_lab` matches no file, so the run finds nothing to do. Several names in one command run several suites.
5252

53-
Write a test for every behavior change. A bug fix needs a test that fails before the fix.
53+
Write or modify a test for every behavior change. A bug fix needs a test that fails before the fix.
5454

5555
For an interaction test, fix the width, height, margins, and both axis ranges. Interaction coordinates count from the top-left corner of the plot, including the margin. A test without fixed geometry turns flaky.
5656

5757
## Image tests
5858

59-
An image test is a mock plus a baseline PNG.
59+
An image test is a JSON mock file plus a baseline PNG image.
6060

6161
- The mock is figure JSON at `test/image/mocks/<name>.json`
6262
- The baseline is `test/image/baselines/<name>.png`

0 commit comments

Comments
 (0)