用途:面向 contentstack-management-javascript 仓库的日常开发与 PR 流程,帮助开发者确定何时运行哪些 npm 脚本、是否需要更新 package.json 版本号,以及 PR 应满足的规范。
主要能力与用法: 分支方面,遵循团队 Git 约定,例如从 development 或本仓库使用的集成分支拉出 feature 分支;提交保持聚焦,不得提交 test.only、it.only、describe.only 或永久性 skip。
提交 PR 前:运行 npm run lint,ESLint 必须在 lib 和 test 上通过;运行单元测试 npm run test:unit(npm test 会先跑 test:api,需确认所在分支的 package.json 中已定义 test:api)。仅在针对实时 CMA 验证时才运行 Sanity/API 测试:先 npm run build,再运行 npm run test:sanity-nocov 或 test:sanity-test,环境变量按 test/sanity-check/utility/testSetup.js 配置,切勿提交密钥。
版本号:对用户可见或值得发布的 lib/ 变更(新 API、已发布修复、破坏性变更),按 semver 在 package.json 中更新 patch/minor/major;仅文档或杂务类 PR 可按团队惯例省略。
PR 期望:面向用户的变更需为公共方法添加 JSDoc,公共接口变化时更新 types/**;除非明确为破坏性变更并已记录,否则保持向后兼容;错误处理使用 lib/core/contentstackError.js 的模式,日志中不得泄露完整 token;单元测试放在 test/unit/ 并使用 mock,sanity 环境与命令参见 AGENTS.md 中列出的 testing 技能。
适用场景:开始新工作、准备推送或开 PR、决定是否升版本时。
限制:资料未提供具体分支名、CI 配置、完整脚本清单及环境变量细节,需以仓库实际配置为准。