Skip to content

Commit 41e91c8

Browse files
committed
Add note for agents and fix broken link, commands
1 parent 903b856 commit 41e91c8

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,18 @@ The Plotly.js community, construed fairly broadly, includes the maintainers and
4444

4545
## Opening issues
4646

47-
Please read the [issue guidelines](./.github/ISSUE_TEMPLATE.md).
47+
Please read the [issue guidelines](./.github/ISSUE_TEMPLATE/) in the appropriate template.
4848

4949
## Making pull requests
5050

5151
Please read the [pull request guidelines](./.github/PULL_REQUEST_TEMPLATE.md).
5252

53+
## Using a coding agent
54+
55+
If you prepare a contribution with a coding agent, point it at [AGENTS.md](AGENTS.md).
56+
That file and the [.agents](.agents/) folder state the rules an agent follows in this
57+
repository, including the steps it must leave to a human.
58+
5359
## GitHub labels
5460

5561
We use the following [labels](https://github.com/plotly/plotly.js/labels) to track issues and PRs:
@@ -216,8 +222,6 @@ files.
216222

217223
- `npm run preprocess`: pre-processes the css and svg source file in js. This
218224
script must be run manually when updating the css and svg source files.
219-
- `npm run watch`: starts a watchify file watcher just like the test dashboard but
220-
without booting up a server.
221225

222226
## Testing
223227

@@ -312,9 +316,9 @@ npm run baseline mock_*
312316
```
313317

314318
**IMPORTANT:** the `baseline`, `test-image` and `test-export` scripts do **not** bundle the source files before
315-
running the image tests. We recommend running `npm run watch` or `npm start` in
319+
running the image tests. We recommend running `npm start` in
316320
a separate tab to ensure that the most up-to-date code is used.
317-
Also if you are adding a new mock, you may need to re-run `npm start` or `npm run watch`
321+
Also if you are adding a new mock, you may need to re-run `npm start`
318322
to be able to find the new mock in the browser.
319323
To help ensure valid attributes are used in your new mock(s), please run `npm run test-mock`
320324
or `npm run test-mock mock_name(s)` after adding new mocks or implementing any new attributes.

0 commit comments

Comments
 (0)