code-review

Use ao revisar PRs para o Management Python SDK — API pública, _APIClient, OAuth, testes, segurança.

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

Mais skills de contentstack

cms-assets
contentstack
Aconselhe desenvolvedores sobre organização, entrega e transformação de ativos no Contentstack. Aborde estrutura de pastas, transformações da Image Delivery API, publicação…
cms-branches-aliases
contentstack
Aconselhe desenvolvedores sobre o uso de branches do Contentstack para desenvolvimento isolado de conteúdo e aliases para implantações de conteúdo sem tempo de inatividade. Cubra estratégia de branches,…
cms-data-modeling-best-practices
contentstack
Orientar desenvolvedores a modelar conteúdo no Contentstack usando a estrutura reutilizável mais simples. A skill explica quando usar content types, references, global…
cms-live-preview-visual-builder-support-assistant
contentstack
Diagnostique e oriente implementações do Contentstack Live Preview e Visual Builder. Rastreie o contexto de preview, identifique o contrato quebrado e recomende a…
cms-releases
contentstack
Orientar desenvolvedores no uso de Contentstack Releases para implantação coordenada e atômica de conteúdo. Abordar criação de releases, gerenciamento de itens, implantação em estágios,…
cms-roles-permissions
contentstack
Aconselhe desenvolvedores sobre o design de funções, permissões, equipes e acesso por token no Contentstack. Explique funções integradas, funções personalizadas, mesclagem de permissões,…
cms-taxonomy
contentstack
Aconselhe desenvolvedores sobre o uso do Contentstack Taxonomy para classificação de conteúdo estruturada e hierárquica e filtragem no lado da entrega. Aborda taxonomy vs tags,…
cms-tokens-authentication
contentstack
Orientar desenvolvedores na escolha do método de autenticação e tipo de token adequados do Contentstack para casos de uso de frontend, backend, automação e aplicativos de terceiros.…