|
9 | 9 |
|
10 | 10 | ## Type of Change |
11 | 11 | <!-- Check the one that applies. --> |
12 | | -- [ ] Code change (new feature, bug fix, refactor) |
13 | | -- [ ] Code change with doc updates |
14 | | -- [ ] Doc only — prose changes (no code sample modifications) |
15 | | -- [ ] Doc only — includes code sample changes |
| 12 | +- [ ] Code change for a new feature, bug fix, or refactor. |
| 13 | +- [ ] Code change with doc updates. |
| 14 | +- [ ] Doc only. Prose changes without code sample modifications. |
| 15 | +- [ ] Doc only. Includes code sample changes. |
16 | 16 |
|
17 | 17 | ## Testing |
18 | 18 | <!-- What testing was done? --> |
19 | | -- [ ] `make check` passes |
20 | | -- [ ] `npm test` passes |
21 | | -- [ ] `make docs` builds without warnings (for doc changes) |
| 19 | +- [ ] `make check` passes. |
| 20 | +- [ ] `npm test` passes. |
| 21 | +- [ ] `make docs` builds without warnings. (for doc-only changes) |
22 | 22 |
|
23 | 23 | ## Checklist |
24 | 24 |
|
25 | | -### Code changes |
| 25 | +### General |
| 26 | +- [ ] I have read and followed the [contributing guide](CONTRIBUTING.md). |
| 27 | +- [ ] I have read and followed the [style guide](docs/CONTRIBUTING.md). (for doc-only changes) |
| 28 | + |
| 29 | +### Code Changes |
26 | 30 | <!-- Skip if this is a doc-only PR. --> |
27 | | -- [ ] `make format` applied (TypeScript and Python) |
28 | | -- [ ] Tests added or updated for new or changed behavior |
29 | | -- [ ] No secrets, API keys, or credentials committed |
30 | | -- [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs) |
| 31 | +- [ ] `make format` applied (TypeScript and Python). |
| 32 | +- [ ] Tests added or updated for new or changed behavior. |
| 33 | +- [ ] No secrets, API keys, or credentials committed. |
| 34 | +- [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs). |
31 | 35 |
|
32 | | -### Doc changes |
| 36 | +### Doc Changes |
33 | 37 | <!-- Skip if this PR has no doc changes. --> |
34 | 38 | - [ ] Follows the [style guide](docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR." |
35 | | -- [ ] New pages include SPDX license header and frontmatter (if creating a new page) |
36 | | -- [ ] Cross-references and links verified |
| 39 | +- [ ] New pages include SPDX license header and frontmatter, if creating a new page. |
| 40 | +- [ ] Cross-references and links verified. |
0 commit comments