code-review

Úsese al revisar PRs para el SDK de Python de Management: API pública, _APIClient, OAuth, pruebas, seguridad.

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

Más skills de contentstack

cms-assets
contentstack
Asesorar a los desarrolladores sobre cómo organizar, entregar y transformar activos en Contentstack. Cubrir la estructura de carpetas, las transformaciones de la API de entrega de imágenes, la publicación…
cms-branches-aliases
contentstack
Asesorar a desarrolladores sobre el uso de ramas de Contentstack para desarrollo de contenido aislado y alias para implementaciones de contenido sin tiempo de inactividad. Cubrir estrategia de ramas, …
cms-data-modeling-best-practices
contentstack
Guía a los desarrolladores para modelar contenido en Contentstack usando la estructura reutilizable más simple. La habilidad explica cuándo usar tipos de contenido, referencias, global...
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnostica y guía implementaciones de Contentstack Live Preview y Visual Builder. Rastrea el contexto de vista previa, identifica el contrato roto y recomienda la…
cms-releases
contentstack
Asesorar a los desarrolladores sobre el uso de Contentstack Releases para la implementación coordinada y atómica de contenido. Cubrir la creación de releases, la gestión de elementos, la implementación por etapas,…
cms-roles-permissions
contentstack
Asesorar a los desarrolladores sobre el diseño de roles, permisos, equipos y acceso mediante tokens en Contentstack. Explicar los roles integrados, roles personalizados, fusión de permisos,…
cms-taxonomy
contentstack
Asesorar a desarrolladores sobre el uso de Contentstack Taxonomy para la clasificación de contenido estructurada y jerárquica y el filtrado en el lado de entrega. Cubre taxonomy vs tags,…
cms-tokens-authentication
contentstack
Asesorar a los desarrolladores sobre cómo elegir el método de autenticación de Contentstack y el tipo de token adecuados para casos de uso de frontend, backend, automatización y aplicaciones de terceros.…