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
就Contentstack Brand Kit的概念、设置、治理及品牌化AI生成向用户提供建议。将API相关任务路由到正确的Brand Kit功能或…
official
cms-assets
contentstack
为开发人员提供关于在Contentstack中组织、交付和转换资产的建议。涵盖文件夹结构、Image Delivery API转换、发布……
official
cms-branches-aliases
contentstack
指导开发者使用Contentstack分支进行隔离的内容开发,并使用别名实现零停机的内容部署。涵盖分支策略、…
official
cms-data-modeling-best-practices
contentstack
指导开发者在Contentstack中使用最简单可复用的结构来建模内容。该技能解释了何时使用内容类型、引用、全局…
official
cms-entries
contentstack
为开发者提供关于查询、本地化、版本管理、发布和构建Contentstack条目的建议,以实现高效交付。重点关注CDA的使用、引用……
official
cms-environments-publishing
contentstack
为开发人员提供关于配置环境、发布内容、使用交付和预览令牌、利用Sync API以及了解CDN和…的建议
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