code-review

작성자: contentstack

Use when reviewing PRs for the Management Python SDK — public API, _APIClient, OAuth, tests, security.

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

contentstack의 다른 스킬

brand-kit-assistant
contentstack
Contentstack Brand Kit 개념, 설정, 거버넌스 및 브랜드에 부합하는 AI 생성에 대해 사용자에게 조언합니다. API 관련 작업을 적절한 Brand Kit 기능으로 라우팅하거나…
official
cms-assets
contentstack
개발자에게 Contentstack에서 자산을 구성, 전달, 변환하는 방법에 대해 조언합니다. 폴더 구조, Image Delivery API 변환, 게시를 다룹니다...
official
cms-branches-aliases
contentstack
Advise developers on using Contentstack branches for isolated content development and aliases for zero-downtime content deployments. Cover branch strategy,…
official
cms-data-modeling-best-practices
contentstack
Guide developers to model content in Contentstack using the simplest reusable structure. The skill explains when to use content types, references, global…
official
cms-entries
contentstack
개발자에게 Contentstack 항목의 효율적인 전달을 위한 쿼리, 현지화, 버전 관리, 게시, 구조화 방법을 조언합니다. CDA 사용, 참조…
official
cms-environments-publishing
contentstack
Advise developers on configuring environments, publishing content, using delivery and preview tokens, leveraging the Sync API, and understanding CDN and…
official
cms-live-preview-visual-builder-support-assistant
contentstack
Contentstack Live Preview 및 Visual Builder 구현을 진단하고 안내합니다. 미리보기 컨텍스트를 추적하고, 손상된 계약을 식별하며, 다음을 권장합니다…
official
cms-localization
contentstack
Advise developers on Contentstack localization: language setup, fallback chains, localized vs unlocalized entries, non-localizable fields, and multi-locale…
official