SKILL.md
Code review – Contentstack Python CDA SDK
When to use
- Reviewing a PR, self-review before submit, or running an automated review pass.
Instructions
Checklist
- API: New or changed
Stack/ content-type / query / entry methods documented;contentstack/init.pyexports updated if needed. - Version:
versionincontentstack/init.pyaligned with release strategy for breaking changes. - HTTP:
https_connection.py/controller.pychanges keep retry and timeout behavior predictable. - Tests:
pytest tests/passes; extendtests/when CDA behavior changes. - Secrets: No tokens in repo;
config.pyremains local-only when it holds real credentials.
Public API
- Exported
Stack,ContentType,Query, asset/entry helpers matchREADMEand consumer expectations;contentstack/init.pyallstays accurate when exports change. - Docstrings on
Stackand key public methods when behavior or options change.
Compatibility
- Avoid breaking
Stack.initsignatures or method chains without a semver strategy; document migration for breaking changes insetup.py/version.
HTTP / dependencies
- Changes to
requests, retry behavior, orHTTPSConnectionshould stay consistent withcontentstack/controller.pyandurllib3.Retryusage instack.py.
Security
- No hardcoded tokens in source or docs; no logging of
apikey,deliverytoken,previewtoken, ormanagementtoken.
Severity (optional)
| Level | Examples |
|---|---|
| Blocker | Breaking public API without approval; security issue; no tests for new logic |
| Major | Inconsistent HTTP/retry behavior; README examples that don't match code |
| Minor | Style; minor docs |