code-review

作者: contentstack

在審查Management Python SDK的PR時使用——公開API、_APIClient、OAuth、測試、安全性。

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 的更多技能

cms-assets
contentstack
為開發人員提供有關在Contentstack中組織、交付和轉換資產的建議。涵蓋資料夾結構、Image Delivery API轉換、發佈……
cms-branches-aliases
contentstack
為開發人員提供使用 Contentstack 分支進行隔離內容開發以及使用別名實現零停機內容部署的建議。涵蓋分支策略,…
cms-data-modeling-best-practices
contentstack
引導開發人員在Contentstack中使用最簡單的可重用結構來建模內容。此技能說明何時使用內容類型、引用、全域…
cms-live-preview-visual-builder-support-assistant
contentstack
診斷並指導 Contentstack Live Preview 和 Visual Builder 的實作。追蹤預覽上下文,識別中斷的合約,並建議…
cms-releases
contentstack
指導開發人員使用 Contentstack Releases 進行協調、原子化的內容部署。涵蓋版本建立、項目管理、分階段部署等內容。
cms-roles-permissions
contentstack
為開發人員提供關於在Contentstack中設計角色、權限、團隊和Token存取權限的建議。解釋內建角色、自訂角色、權限合併等。
cms-taxonomy
contentstack
為開發人員提供關於使用 Contentstack Taxonomy 進行結構化、階層式內容分類及傳遞端篩選的建議。涵蓋 taxonomy 與 tags 的比較,…
cms-tokens-authentication
contentstack
為開發人員提供建議,協助他們為前端、後端、自動化及第三方應用程式使用情境選擇正確的Contentstack驗證方法與權杖類型。…