Cursor rule

1---
2description: PR review checklist for @contentstack/utils — API docs, compatibility, security, testing
3alwaysApply: true
4---
5 
6# Code review checklist — `@contentstack/utils`
7 
8Use severity labels (**Blocker / Major / Minor**) when triaging findings.
9 
10## Public API and documentation
11 
12- **Blocker/Major:** New or changed **exports** from `src/index.ts` need accurate **JSDoc** (or clear type names) matching runtime behavior.
13- **Major:** README / CHANGELOG updates when behavior is user-visible or migration is needed.
14 
15## Backward compatibility
16 
17- **Blocker:** Unplanned breaking changes to **function signatures** or **default behavior** consumed by Delivery SDK integrations or documented `renderOption` contracts.
18- **Major:** Stricter throwing on inputs that previously passed (especially `getContentstackEndpoint`, RTE traversals).
19 
20## Errors
21 
22- This package uses **plain `Error`** (e.g. `endpoints.ts`); new code should keep messages actionable. **Major:** Silent failures where callers need to detect bad input.
23 
24## Null safety and RTE edge cases
25 
26- **Major:** Missing guards on **null/undefined** node or entry fragments (historically sensitive in `entry-editable` / RTE paths).
27- **Minor:** Align with **`strictNullChecks: false`** legacy but avoid widening undefined leaks into public types.
28 
29## Dependencies and SCA
30 
31- **Major:** New runtime deps are rare—justify any addition; **`prepublishOnly`** and hooks assume **`npm test`** and Snyk-friendly trees.
32- Use **`npm audit` / Snyk** expectations per org policy.
33 
34## Tests
35 
36- **Blocker:** Behavioral fixes or new branches without **`__test__`** coverage when risk is high (RTE nesting, GQL URL rewriting, endpoint resolution).
37- **Minor:** Snapshot-only tests where a small assertion would be clearer.
38 
39## Terminology
40 
41- **Major:** Docs/comments must describe this as **utils** alongside **CDA / Delivery / JSON RTE / GraphQL**, not as **CMA** unless the change is explicitly management-related.
42