code-review

作者: contentstack

PR 審查檢查清單,適用於 datasync-asset-store-filesystem — 在開啟或審查拉取請求時使用。

npx skills add https://github.com/contentstack/datasync-asset-store-filesystem --skill code-review

Code review – DataSync Asset Store Filesystem

When to use

  • Opening a PR that touches src/, tests, or published artifacts
  • Reviewing changes for a library release

Instructions

  • Build and tests: Branch should pass npm run build-ts and npm test locally.
  • Lint: Run npm run tslint for TypeScript changes in src/.
  • API and docs: If public behavior or defaults change, update root README.md and verify datasync-asset-store assumptions still hold.
  • Versioning: Bump package.json version when releasing; follow org conventions for tags and changelog if applicable.
  • Security: Avoid logging secrets; path handling should remain safe (see existing sanitization in src/utils.ts and related code). Large dependency or HTTP behavior changes deserve extra scrutiny.
  • Scope: Keep changes focused on the asset-store concern—avoid unrelated refactors in the same PR unless required for the fix.

來自 contentstack 的更多技能

brand-kit-assistant
contentstack
Advise users on Contentstack Brand Kit concepts, setup, governance, and on-brand AI generation. Route API-specific tasks to the right Brand Kit capability or…
official
cms-assets
contentstack
Advise developers on organizing, delivering, and transforming assets in Contentstack. Cover folder structure, Image Delivery API transformations, publishing…
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
Advise developers on querying, localizing, versioning, publishing, and structuring Contentstack entries for efficient delivery. Focus on CDA usage, reference…
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
Diagnose and guide Contentstack Live Preview and Visual Builder implementations. Trace preview context, identify the broken contract, and recommend the…
official
cms-localization
contentstack
為開發人員提供Contentstack本地化建議:語言設定、備援鏈、本地化與非本地化條目、不可本地化欄位,以及多語言環境…
official