code-review

À utiliser lors de la revue des PR pour le SDK Python de Management — API publique, _APIClient, OAuth, tests, sécurité.

npx skills add https://github.com/contentstack/contentstack-management-python --skill code-review

Code review – Contentstack Management Python

When to use

  • Reviewing a PR, self-review before submit, or automated review prompts.

Instructions

Work through the checklist below. Optionally tag findings: Blocker, Major, Minor.

Public API

  • Exported Client, Region, stack and resource helpers match README and contentstack_management.__all__ / __init__.py.
  • Docstrings on Client and changed public methods when behavior or parameters change.

Compatibility

  • Avoid breaking Client constructor or stack method chains without a semver strategy; document migration for breaking changes.

HTTP / auth

  • Changes to _APIClient or OAuth paths: verify retries, headers, and interceptor behavior with unit tests; no regressions for authtoken / management_token headers.

Testing

  • Unit coverage for new logic; API updates when live CMA request/response behavior changes; mock when contract-style tests are appropriate.
  • pytest tests/unit/ passes.

Security

  • No hardcoded tokens; no logging secrets in new code.

Severity (optional)

LevelExamples
BlockerBreaking public API without approval; security issue; no tests for new logic where tests are practical
MajorInconsistent HTTP/auth behavior; README examples that do not match code
MinorStyle; minor docs

Plus de skills de contentstack

cms-assets
contentstack
Conseiller les développeurs sur l'organisation, la livraison et la transformation des assets dans Contentstack. Couvrir la structure des dossiers, les transformations de l'API de livraison d'images, la publication…
cms-branches-aliases
contentstack
Conseiller les développeurs sur l'utilisation des branches Contentstack pour le développement de contenu isolé et des alias pour des déploiements de contenu sans temps d'arrêt. Couvrir la stratégie de branche,…
cms-data-modeling-best-practices
contentstack
Guidez les développeurs pour modéliser le contenu dans Contentstack en utilisant la structure réutilisable la plus simple. La compétence explique quand utiliser les types de contenu, les références, les éléments globaux…
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnostiquer et guider les implémentations de Contentstack Live Preview et Visual Builder. Retracer le contexte d'aperçu, identifier le contrat rompu et recommander le…
cms-releases
contentstack
Conseiller les développeurs sur l'utilisation de Contentstack Releases pour un déploiement coordonné et atomique de contenu. Couvrir la création de releases, la gestion des éléments, le déploiement par étapes,…
cms-roles-permissions
contentstack
Conseiller les développeurs sur la conception des rôles, des permissions, des équipes et de l'accès par jeton dans Contentstack. Expliquer les rôles intégrés, les rôles personnalisés, la fusion des permissions,…
cms-taxonomy
contentstack
Conseiller les développeurs sur l'utilisation de Contentstack Taxonomy pour la classification structurée et hiérarchique du contenu et le filtrage côté livraison. Couvre la taxonomie par rapport aux balises,…
cms-tokens-authentication
contentstack
Conseiller les développeurs sur le choix de la méthode d'authentification Contentstack et du type de jeton adaptés aux cas d'utilisation frontend, backend, d'automatisation et d'applications tierces.…