artifact-chain-assistant 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/plugins/marketplace.json +20 -0
- package/.claude-plugin/marketplace.json +20 -0
- package/.claude-plugin/plugin.json +11 -0
- package/.codex-plugin/plugin.json +27 -0
- package/.github/ISSUE_TEMPLATE/bug_report.yml +26 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +19 -0
- package/.github/pull_request_template.md +14 -0
- package/.github/workflows/ci.yml +23 -0
- package/CHANGELOG.md +196 -0
- package/CODE_OF_CONDUCT.md +11 -0
- package/CONTRIBUTING.md +24 -0
- package/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/INSTALL.md +1340 -0
- package/LICENSE +186 -0
- package/NOTICE +18 -0
- package/README.md +426 -0
- package/README.zh-CN.md +409 -0
- package/SECURITY.md +19 -0
- package/adapters/claude/.claude-plugin/plugin.json +11 -0
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/adapters/claude/INSTALL.md +1340 -0
- package/adapters/claude/agent-methods/catalog.yaml +260 -0
- package/adapters/claude/bin/version-lock-audit.sh +21 -0
- package/adapters/claude/bin/version-lock-refresh.sh +21 -0
- package/adapters/claude/commands/version-lock-audit.md +9 -0
- package/adapters/claude/commands/version-lock-refresh.md +9 -0
- package/adapters/claude/compatibility.json +9 -0
- package/adapters/claude/hooks/hooks.json +16 -0
- package/adapters/claude/hooks/version-lock-stop.mjs +77 -0
- package/adapters/claude/schemas/artifact-workflow-profile.schema.json +72 -0
- package/adapters/claude/scripts/batch-merge.mjs +276 -0
- package/adapters/claude/scripts/batch-split.mjs +184 -0
- package/adapters/claude/scripts/check-workflow-profile.mjs +64 -0
- package/adapters/claude/scripts/doctor.mjs +44 -0
- package/adapters/claude/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/adapters/claude/scripts/lib/compatibility-policy.mjs +435 -0
- package/adapters/claude/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/adapters/claude/scripts/lib/method-registry-version.mjs +7 -0
- package/adapters/claude/scripts/lib/workflow-profile.mjs +645 -0
- package/adapters/claude/scripts/run-artifact-workflow.mjs +366 -0
- package/adapters/claude/skills/artifact-audit/SKILL.md +80 -0
- package/adapters/claude/skills/artifact-batch/SKILL.md +115 -0
- package/adapters/claude/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/adapters/claude/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/adapters/claude/skills/artifact-generate/SKILL.md +89 -0
- package/adapters/claude/skills/artifact-repair/SKILL.md +124 -0
- package/adapters/claude/skills/artifact-review/SKILL.md +122 -0
- package/adapters/claude/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/adapters/claude/skills/prd-feature/SKILL.md +68 -0
- package/adapters/claude/skills/prd-feature/author/SKILL.md +92 -0
- package/adapters/claude/skills/prd-feature/references/compose.md +43 -0
- package/adapters/claude/skills/prd-feature/references/inspect.md +94 -0
- package/adapters/claude/skills/prd-feature/references/validate.md +65 -0
- package/adapters/claude/skills/prd-feature/repair/SKILL.md +135 -0
- package/adapters/claude/skills/prd-feature/review/SKILL.md +134 -0
- package/adapters/claude/skills/scenario-script/SKILL.md +76 -0
- package/adapters/claude/skills/scenario-script/author/SKILL.md +111 -0
- package/adapters/claude/skills/scenario-script/references/compose.md +43 -0
- package/adapters/claude/skills/scenario-script/references/inspect.md +105 -0
- package/adapters/claude/skills/scenario-script/references/validate.md +72 -0
- package/adapters/claude/skills/scenario-script/repair/SKILL.md +135 -0
- package/adapters/claude/skills/scenario-script/review/SKILL.md +137 -0
- package/adapters/claude/skills/where-am-i/SKILL.md +233 -0
- package/adapters/claude/templates/README.md +159 -0
- package/adapters/claude/templates/core/decision/review-checklist.md +35 -0
- package/adapters/claude/templates/core/decision/starter.md +66 -0
- package/adapters/claude/templates/core/design/review-checklist.md +41 -0
- package/adapters/claude/templates/core/design/starter.md +84 -0
- package/adapters/claude/templates/core/e2e_test/review-checklist.md +43 -0
- package/adapters/claude/templates/core/e2e_test/starter.md +70 -0
- package/adapters/claude/templates/core/feature/review-checklist.md +29 -0
- package/adapters/claude/templates/core/feature/starter.md +43 -0
- package/adapters/claude/templates/core/scenario/review-checklist.md +29 -0
- package/adapters/claude/templates/core/scenario/starter.md +57 -0
- package/adapters/claude/templates/core/test/review-checklist.md +37 -0
- package/adapters/claude/templates/core/test/starter.md +70 -0
- package/adapters/claude/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/adapters/claude/templates/extended/README.md +261 -0
- package/adapters/claude/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/agent/agent_skill/starter.md +133 -0
- package/adapters/claude/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/adapters/claude/templates/extended/agent/hook_policy/starter.md +134 -0
- package/adapters/claude/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/adapters/claude/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/adapters/claude/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/contracts/api_contract/starter.md +92 -0
- package/adapters/claude/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/adapters/claude/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/adapters/claude/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/adapters/claude/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/adapters/claude/templates/extended/contracts/data_contract/starter.md +88 -0
- package/adapters/claude/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/adapters/claude/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/adapters/claude/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/adapters/claude/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/adapters/claude/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/adapters/claude/templates/extended/contracts/report_contract/starter.md +97 -0
- package/adapters/claude/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/adapters/claude/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/adapters/claude/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/domain/database_migration/starter.md +115 -0
- package/adapters/claude/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/domain/domain_model/starter.md +83 -0
- package/adapters/claude/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/adapters/claude/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/adapters/claude/templates/extended/governance/publish_skill/starter.md +172 -0
- package/adapters/claude/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/adapters/claude/templates/extended/governance/release_policy/starter.md +131 -0
- package/adapters/claude/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/adapters/claude/templates/extended/ops/migration_plan/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/adapters/claude/templates/extended/ops/performance_budget/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/ops/runbook/starter.md +101 -0
- package/adapters/claude/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/adapters/claude/templates/extended/ops/security_review/starter.md +125 -0
- package/adapters/codex/.codex-plugin/plugin.json +27 -0
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/adapters/codex/INSTALL.md +1340 -0
- package/adapters/codex/agent-methods/catalog.yaml +260 -0
- package/adapters/codex/compatibility.json +9 -0
- package/adapters/codex/schemas/artifact-workflow-profile.schema.json +72 -0
- package/adapters/codex/scripts/batch-merge.mjs +276 -0
- package/adapters/codex/scripts/batch-split.mjs +184 -0
- package/adapters/codex/scripts/check-workflow-profile.mjs +64 -0
- package/adapters/codex/scripts/doctor.mjs +44 -0
- package/adapters/codex/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/adapters/codex/scripts/lib/compatibility-policy.mjs +435 -0
- package/adapters/codex/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/adapters/codex/scripts/lib/method-registry-version.mjs +7 -0
- package/adapters/codex/scripts/lib/workflow-profile.mjs +645 -0
- package/adapters/codex/scripts/run-artifact-workflow.mjs +366 -0
- package/adapters/codex/skills/artifact-audit/SKILL.md +80 -0
- package/adapters/codex/skills/artifact-batch/SKILL.md +115 -0
- package/adapters/codex/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/adapters/codex/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/adapters/codex/skills/artifact-generate/SKILL.md +89 -0
- package/adapters/codex/skills/artifact-repair/SKILL.md +124 -0
- package/adapters/codex/skills/artifact-review/SKILL.md +122 -0
- package/adapters/codex/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/adapters/codex/skills/prd-feature/SKILL.md +68 -0
- package/adapters/codex/skills/prd-feature/author/SKILL.md +92 -0
- package/adapters/codex/skills/prd-feature/references/compose.md +43 -0
- package/adapters/codex/skills/prd-feature/references/inspect.md +94 -0
- package/adapters/codex/skills/prd-feature/references/validate.md +65 -0
- package/adapters/codex/skills/prd-feature/repair/SKILL.md +135 -0
- package/adapters/codex/skills/prd-feature/review/SKILL.md +134 -0
- package/adapters/codex/skills/scenario-script/SKILL.md +76 -0
- package/adapters/codex/skills/scenario-script/author/SKILL.md +111 -0
- package/adapters/codex/skills/scenario-script/references/compose.md +43 -0
- package/adapters/codex/skills/scenario-script/references/inspect.md +105 -0
- package/adapters/codex/skills/scenario-script/references/validate.md +72 -0
- package/adapters/codex/skills/scenario-script/repair/SKILL.md +135 -0
- package/adapters/codex/skills/scenario-script/review/SKILL.md +137 -0
- package/adapters/codex/skills/where-am-i/SKILL.md +233 -0
- package/adapters/codex/templates/README.md +159 -0
- package/adapters/codex/templates/core/decision/review-checklist.md +35 -0
- package/adapters/codex/templates/core/decision/starter.md +66 -0
- package/adapters/codex/templates/core/design/review-checklist.md +41 -0
- package/adapters/codex/templates/core/design/starter.md +84 -0
- package/adapters/codex/templates/core/e2e_test/review-checklist.md +43 -0
- package/adapters/codex/templates/core/e2e_test/starter.md +70 -0
- package/adapters/codex/templates/core/feature/review-checklist.md +29 -0
- package/adapters/codex/templates/core/feature/starter.md +43 -0
- package/adapters/codex/templates/core/scenario/review-checklist.md +29 -0
- package/adapters/codex/templates/core/scenario/starter.md +57 -0
- package/adapters/codex/templates/core/test/review-checklist.md +37 -0
- package/adapters/codex/templates/core/test/starter.md +70 -0
- package/adapters/codex/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/adapters/codex/templates/extended/README.md +261 -0
- package/adapters/codex/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/agent/agent_skill/starter.md +133 -0
- package/adapters/codex/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/adapters/codex/templates/extended/agent/hook_policy/starter.md +134 -0
- package/adapters/codex/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/adapters/codex/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/adapters/codex/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/contracts/api_contract/starter.md +92 -0
- package/adapters/codex/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/adapters/codex/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/adapters/codex/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/adapters/codex/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/adapters/codex/templates/extended/contracts/data_contract/starter.md +88 -0
- package/adapters/codex/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/adapters/codex/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/adapters/codex/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/adapters/codex/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/adapters/codex/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/adapters/codex/templates/extended/contracts/report_contract/starter.md +97 -0
- package/adapters/codex/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/adapters/codex/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/adapters/codex/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/domain/database_migration/starter.md +115 -0
- package/adapters/codex/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/domain/domain_model/starter.md +83 -0
- package/adapters/codex/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/adapters/codex/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/adapters/codex/templates/extended/governance/publish_skill/starter.md +172 -0
- package/adapters/codex/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/adapters/codex/templates/extended/governance/release_policy/starter.md +131 -0
- package/adapters/codex/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/adapters/codex/templates/extended/ops/migration_plan/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/adapters/codex/templates/extended/ops/performance_budget/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/ops/runbook/starter.md +101 -0
- package/adapters/codex/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/adapters/codex/templates/extended/ops/security_review/starter.md +125 -0
- package/agent-methods/catalog.yaml +260 -0
- package/compatibility.json +9 -0
- package/package.json +85 -0
- package/runtime/claude/version-lock-stop.mjs +77 -0
- package/schemas/artifact-workflow-profile.schema.json +72 -0
- package/scripts/batch-merge.mjs +276 -0
- package/scripts/batch-split.mjs +184 -0
- package/scripts/build-adapters.mjs +195 -0
- package/scripts/build-runtime-bundles.mjs +134 -0
- package/scripts/check-compatibility.mjs +19 -0
- package/scripts/check-method-registry.mjs +461 -0
- package/scripts/check-templates.mjs +348 -0
- package/scripts/check-workflow-profile.mjs +64 -0
- package/scripts/doctor.mjs +44 -0
- package/scripts/install-git-hooks.mjs +21 -0
- package/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/scripts/lib/compatibility-policy.mjs +435 -0
- package/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/scripts/lib/method-registry-version.mjs +7 -0
- package/scripts/lib/workflow-profile.mjs +645 -0
- package/scripts/run-artifact-workflow.mjs +366 -0
- package/scripts/sync-skills.mjs +149 -0
- package/skills-src/artifact-audit/SKILL.md +80 -0
- package/skills-src/artifact-batch/SKILL.md +115 -0
- package/skills-src/artifact-chain-bootstrap/SKILL.md +343 -0
- package/skills-src/artifact-chain-maintainer/SKILL.md +167 -0
- package/skills-src/artifact-generate/SKILL.md +89 -0
- package/skills-src/artifact-repair/SKILL.md +124 -0
- package/skills-src/artifact-review/SKILL.md +122 -0
- package/skills-src/artifact-workflow-worker/SKILL.md +90 -0
- package/skills-src/prd-feature/SKILL.md +68 -0
- package/skills-src/prd-feature/author/SKILL.md +92 -0
- package/skills-src/prd-feature/references/compose.md +43 -0
- package/skills-src/prd-feature/references/inspect.md +94 -0
- package/skills-src/prd-feature/references/validate.md +65 -0
- package/skills-src/prd-feature/repair/SKILL.md +135 -0
- package/skills-src/prd-feature/review/SKILL.md +134 -0
- package/skills-src/scenario-script/SKILL.md +76 -0
- package/skills-src/scenario-script/author/SKILL.md +111 -0
- package/skills-src/scenario-script/references/compose.md +43 -0
- package/skills-src/scenario-script/references/inspect.md +105 -0
- package/skills-src/scenario-script/references/validate.md +72 -0
- package/skills-src/scenario-script/repair/SKILL.md +135 -0
- package/skills-src/scenario-script/review/SKILL.md +137 -0
- package/skills-src/where-am-i/SKILL.md.tpl +233 -0
- package/templates/README.md +159 -0
- package/templates/claude/marketplace.json.tpl +20 -0
- package/templates/claude/plugin.json.tpl +11 -0
- package/templates/claude/settings.json.tpl +16 -0
- package/templates/codex/marketplace.json.tpl +20 -0
- package/templates/codex/plugin.json.tpl +27 -0
- package/templates/core/decision/review-checklist.md +35 -0
- package/templates/core/decision/starter.md +66 -0
- package/templates/core/design/review-checklist.md +41 -0
- package/templates/core/design/starter.md +84 -0
- package/templates/core/e2e_test/review-checklist.md +43 -0
- package/templates/core/e2e_test/starter.md +70 -0
- package/templates/core/feature/review-checklist.md +29 -0
- package/templates/core/feature/starter.md +43 -0
- package/templates/core/scenario/review-checklist.md +29 -0
- package/templates/core/scenario/starter.md +57 -0
- package/templates/core/test/review-checklist.md +37 -0
- package/templates/core/test/starter.md +70 -0
- package/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/templates/extended/README.md +261 -0
- package/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/templates/extended/agent/agent_skill/starter.md +133 -0
- package/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/templates/extended/agent/hook_policy/starter.md +134 -0
- package/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/templates/extended/contracts/api_contract/starter.md +92 -0
- package/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/templates/extended/contracts/data_contract/starter.md +88 -0
- package/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/templates/extended/contracts/report_contract/starter.md +97 -0
- package/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/templates/extended/domain/database_migration/starter.md +115 -0
- package/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/templates/extended/domain/domain_model/starter.md +83 -0
- package/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/templates/extended/governance/publish_skill/starter.md +172 -0
- package/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/templates/extended/governance/release_policy/starter.md +131 -0
- package/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/templates/extended/ops/migration_plan/starter.md +117 -0
- package/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/templates/extended/ops/performance_budget/starter.md +117 -0
- package/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/templates/extended/ops/runbook/starter.md +101 -0
- package/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/templates/extended/ops/security_review/starter.md +125 -0
- package/templates/git-hooks/pre-commit.sh +43 -0
- package/templates/git-hooks/pre-push.sh +22 -0
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# {测试文件名称}
|
|
2
|
+
|
|
3
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
4
|
+
<!-- 测试制品通常是代码文件,此模板提供测试结构指引 -->
|
|
5
|
+
|
|
6
|
+
## 测试结构指引
|
|
7
|
+
|
|
8
|
+
### 单元测试
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
describe('{模块/函数名称}', () => {
|
|
12
|
+
it('should {预期行为} when {条件}', () => {
|
|
13
|
+
// Arrange
|
|
14
|
+
const input = {测试输入};
|
|
15
|
+
|
|
16
|
+
// Act
|
|
17
|
+
const result = {被测函数}(input);
|
|
18
|
+
|
|
19
|
+
// Assert
|
|
20
|
+
expect(result).toEqual({预期输出});
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('should throw error when {异常条件}', () => {
|
|
24
|
+
// Arrange
|
|
25
|
+
const invalidInput = {无效输入};
|
|
26
|
+
|
|
27
|
+
// Act & Assert
|
|
28
|
+
expect(() => {被测函数}(invalidInput)).toThrow({预期错误});
|
|
29
|
+
});
|
|
30
|
+
});
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 集成测试
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
describe('{模块集成}', () => {
|
|
37
|
+
beforeAll(async () => {
|
|
38
|
+
// 初始化测试环境
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
afterAll(async () => {
|
|
42
|
+
// 清理测试环境
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it('should {集成场景描述}', async () => {
|
|
46
|
+
// Arrange
|
|
47
|
+
const {依赖} = await {初始化依赖}();
|
|
48
|
+
|
|
49
|
+
// Act
|
|
50
|
+
const result = await {被测流程}({依赖});
|
|
51
|
+
|
|
52
|
+
// Assert
|
|
53
|
+
expect(result).toMatchObject({预期结果});
|
|
54
|
+
});
|
|
55
|
+
});
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 测试覆盖要求
|
|
59
|
+
|
|
60
|
+
- [ ] 正常路径测试
|
|
61
|
+
- [ ] 边界条件测试
|
|
62
|
+
- [ ] 异常路径测试
|
|
63
|
+
- [ ] 性能关键路径测试(如适用)
|
|
64
|
+
|
|
65
|
+
## 关联制品
|
|
66
|
+
|
|
67
|
+
<!-- 在源码中使用追溯注释 -->
|
|
68
|
+
<!-- @feature {FEATURE_ID} -->
|
|
69
|
+
<!-- @scenario {SCENARIO_ID} -->
|
|
70
|
+
<!-- @decision {DECISION_ID} -->
|
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
# Starter 模板采用指南
|
|
2
|
+
|
|
3
|
+
本指南说明如何将插件 starter 模板定制为项目本地权威模板,以及后续模板升级时的评审流程。
|
|
4
|
+
|
|
5
|
+
## 概述
|
|
6
|
+
|
|
7
|
+
`artifact-chain-assistant` 提供的 starter 模板是**入门指导**,不是项目权威。项目采用扩展制品类型时,必须将 starter 模板复制到本地并定制,定制后的模板成为项目权威。
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
插件 starter 模板(入门指导)
|
|
11
|
+
↓ 复制 + 定制
|
|
12
|
+
项目本地模板(权威)
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## 采用流程
|
|
16
|
+
|
|
17
|
+
### 步骤 1:评估是否需要该类型
|
|
18
|
+
|
|
19
|
+
在采用前,确认项目有对应的本地证据:
|
|
20
|
+
|
|
21
|
+
| 制品类型 | 启用证据 |
|
|
22
|
+
|---------|---------|
|
|
23
|
+
| `api_contract` | 存在 OpenAPI spec、API 文档或 REST 端点代码 |
|
|
24
|
+
| `cli_contract` | 存在 CLI 入口代码或命令定义 |
|
|
25
|
+
| `data_contract` | 存在数据模型定义或 schema 文件 |
|
|
26
|
+
| `domain_model` | 存在 DDD 聚合、实体或值对象代码 |
|
|
27
|
+
| `database_migration` | 存在数据库 schema 或迁移脚本 |
|
|
28
|
+
| `security_review` | 存在安全审查流程、安全相关代码或 Spring Security 配置 |
|
|
29
|
+
| `performance_budget` | 存在性能测试脚本、监控配置或性能基线文档 |
|
|
30
|
+
| `migration_plan` | 存在迁移规划文档、架构演进方案或系统过渡计划 |
|
|
31
|
+
| `runbook` | 存在运维流程或操作手册 |
|
|
32
|
+
| `deployment_manifest` | 存在部署配置(K8s、Docker 等) |
|
|
33
|
+
| `agent_skill` | 存在 Agent 技能定义文件 |
|
|
34
|
+
| `hook_policy` | 存在 CI/CD hook 配置 |
|
|
35
|
+
|
|
36
|
+
**规则**:仅当本地证据存在时才启用对应类型。不要因为插件提供了模板就启用。
|
|
37
|
+
|
|
38
|
+
### 步骤 2:复制 starter 模板到项目本地
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# 示例:复制 api_contract starter
|
|
42
|
+
cp plugins/artifact-chain-assistant/templates/extended/contracts/api_contract/starter.md \
|
|
43
|
+
artifacts/templates/api_contract.md
|
|
44
|
+
|
|
45
|
+
# 示例:复制 review checklist
|
|
46
|
+
cp plugins/artifact-chain-assistant/templates/extended/contracts/api_contract/review-checklist.md \
|
|
47
|
+
artifacts/templates/api_contract-review-checklist.md
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**推荐目录结构**:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
artifacts/templates/
|
|
54
|
+
api_contract.md # 制品模板
|
|
55
|
+
api_contract-review-checklist.md # 审查清单
|
|
56
|
+
cli_contract.md
|
|
57
|
+
cli_contract-review-checklist.md
|
|
58
|
+
...
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 步骤 3:定制模板内容
|
|
62
|
+
|
|
63
|
+
定制四个维度:
|
|
64
|
+
|
|
65
|
+
#### 3.1 定制路径
|
|
66
|
+
|
|
67
|
+
修改 `artifact-graph.config.yaml` 中的 `types.{type}.paths`,匹配项目实际目录结构:
|
|
68
|
+
|
|
69
|
+
```yaml
|
|
70
|
+
types:
|
|
71
|
+
api_contract:
|
|
72
|
+
paths: ["artifacts/contracts/api/**/*.md"] # 按项目实际路径调整
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
#### 3.2 定制 ID 模式
|
|
76
|
+
|
|
77
|
+
修改 `artifact-graph.config.yaml` 中的 `idPatterns.{type}`,匹配项目命名规范:
|
|
78
|
+
|
|
79
|
+
```yaml
|
|
80
|
+
idPatterns:
|
|
81
|
+
api_contract: "^API-\\d+$" # 或 "{service}-API-{version}" 等项目特定模式
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
#### 3.3 定制 frontmatter
|
|
85
|
+
|
|
86
|
+
修改模板中的 frontmatter 字段,匹配项目需求:
|
|
87
|
+
|
|
88
|
+
```markdown
|
|
89
|
+
---
|
|
90
|
+
id: {API_ID} # 替换为项目 ID 模式,如 API-001
|
|
91
|
+
title: {API 名称} # 替换为实际标题
|
|
92
|
+
status: draft # 按项目状态值调整
|
|
93
|
+
version: {v1} # 替换为实际版本
|
|
94
|
+
base_url: {基础 URL} # 替换为实际 URL
|
|
95
|
+
related_features: [] # 填入关联的功能特性 ID
|
|
96
|
+
---
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
**必须保留的字段**:`id`、`title`、`status`(artifact-graph 依赖这些字段索引)
|
|
100
|
+
|
|
101
|
+
**可扩展的字段**:根据制品类型添加项目特定字段(如 `api_contract` 的 `base_url`、`version`)
|
|
102
|
+
|
|
103
|
+
#### 3.4 定制 review checklist
|
|
104
|
+
|
|
105
|
+
修改审查清单,添加项目特定检查项:
|
|
106
|
+
|
|
107
|
+
```markdown
|
|
108
|
+
## 项目特定检查项
|
|
109
|
+
|
|
110
|
+
- [ ] 与项目 API 网关集成点一致
|
|
111
|
+
- [ ] 符合项目安全认证规范
|
|
112
|
+
- [ ] 响应时间满足 SLA 要求
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
**规则**:项目本地审查规则覆盖插件通用基线。
|
|
116
|
+
|
|
117
|
+
### 步骤 4:在 artifacts/README.md 中记录模板来源
|
|
118
|
+
|
|
119
|
+
在项目 `artifacts/README.md` 或模板目录的 README 中记录:
|
|
120
|
+
|
|
121
|
+
```markdown
|
|
122
|
+
## 扩展制品模板
|
|
123
|
+
|
|
124
|
+
本项目采用以下扩展制品类型,模板来自插件 `templates/extended/`,已定制为本地权威:
|
|
125
|
+
|
|
126
|
+
| 制品类型 | 模板路径 | 定制日期 | 定制摘要 |
|
|
127
|
+
|---------|---------|---------|---------|
|
|
128
|
+
| api_contract | artifacts/templates/api_contract.md | 2026-07-09 | 添加项目认证规范、调整 ID 模式 |
|
|
129
|
+
| runbook | artifacts/templates/runbook.md | 2026-07-09 | 添加告警关联规则 |
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### 步骤 5:更新 config 并验证
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
# 1. 更新 config
|
|
136
|
+
# 编辑 artifact-graph.config.yaml 添加新类型
|
|
137
|
+
|
|
138
|
+
# 2. 验证图
|
|
139
|
+
artifact-graph validate --root . --warning-only
|
|
140
|
+
|
|
141
|
+
# 3. 刷新版本锁
|
|
142
|
+
artifact-graph version-lock refresh --all --format markdown
|
|
143
|
+
|
|
144
|
+
# 4. 审计版本锁
|
|
145
|
+
artifact-graph version-lock audit --root . --strict-missing-lock
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### 步骤 6:提交变更
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
git add artifact-graph.config.yaml artifacts/templates/ artifacts/README.md
|
|
152
|
+
git commit -m "feat: adopt api_contract template with local customization"
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## 模板升级评审流程
|
|
156
|
+
|
|
157
|
+
当 `artifact-chain-assistant` 发布新版本且更新了 starter 模板时,已采用项目需要评审是否同步更新本地模板。
|
|
158
|
+
|
|
159
|
+
### 步骤 1:发现变更
|
|
160
|
+
|
|
161
|
+
查看插件 `CHANGELOG.md` 或 `templates/extended/` 目录的 git diff:
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
# 查看模板目录变更
|
|
165
|
+
git diff HEAD~1 plugins/artifact-chain-assistant/templates/extended/
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### 步骤 2:对比本地模板
|
|
169
|
+
|
|
170
|
+
使用 diff 工具对比插件 starter 和项目本地模板:
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
# 对比 api_contract 模板
|
|
174
|
+
diff plugins/artifact-chain-assistant/templates/extended/contracts/api_contract/starter.md \
|
|
175
|
+
artifacts/templates/api_contract.md
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
**diff 关注点**:
|
|
179
|
+
- 插件新增的章节是否对项目有用
|
|
180
|
+
- 插件修改的审查点是否应纳入项目审查清单
|
|
181
|
+
- 插件删除的章节是否项目仍在使用
|
|
182
|
+
|
|
183
|
+
### 步骤 3:评审决策
|
|
184
|
+
|
|
185
|
+
| 情况 | 决策 |
|
|
186
|
+
|------|------|
|
|
187
|
+
| 插件新增了有用的章节 | 选择性合入本地模板 |
|
|
188
|
+
| 插件修改了通用审查点 | 评估是否提升项目审查标准 |
|
|
189
|
+
| 插件删除了项目使用的章节 | 保留本地版本,不跟随删除 |
|
|
190
|
+
| 插件模板与本地模板冲突 | 以本地模板为准,插件仅作参考 |
|
|
191
|
+
|
|
192
|
+
**核心原则**:项目本地模板是权威,插件 starter 是参考。不要盲目同步。
|
|
193
|
+
|
|
194
|
+
### 步骤 4:选择性合并
|
|
195
|
+
|
|
196
|
+
手动合并有用的变更到本地模板:
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
# 不要直接复制覆盖!手动编辑合并
|
|
200
|
+
vim artifacts/templates/api_contract.md
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### 步骤 5:更新审查清单
|
|
204
|
+
|
|
205
|
+
如果插件更新了 review-checklist.md,评估并选择性合入:
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
# 对比审查清单
|
|
209
|
+
diff plugins/artifact-chain-assistant/templates/extended/contracts/api_contract/review-checklist.md \
|
|
210
|
+
artifacts/templates/api_contract-review-checklist.md
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### 步骤 6:记录升级
|
|
214
|
+
|
|
215
|
+
在模板目录 README 中记录升级历史:
|
|
216
|
+
|
|
217
|
+
```markdown
|
|
218
|
+
## 升级历史
|
|
219
|
+
|
|
220
|
+
| 日期 | 插件版本 | 变更摘要 |
|
|
221
|
+
|------|---------|---------|
|
|
222
|
+
| 2026-07-09 | v1.2.0 | 合入插件新增的"安全认证"章节 |
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
## 常见问题
|
|
226
|
+
|
|
227
|
+
### Q: 可以直接引用插件 starter 模板吗?
|
|
228
|
+
|
|
229
|
+
**A: 不可以。** 插件 starter 是入门指导,不是权威。必须复制到本地定制后使用。
|
|
230
|
+
|
|
231
|
+
### Q: 插件更新时需要同步吗?
|
|
232
|
+
|
|
233
|
+
**A: 不需要自动同步。** 评审插件变更,选择性合入有用的部分。本地模板是权威。
|
|
234
|
+
|
|
235
|
+
### Q: 如何确认模板已定制完成?
|
|
236
|
+
|
|
237
|
+
**A: 检查清单**:
|
|
238
|
+
- [ ] 模板已复制到 `artifacts/templates/` 或等价位置
|
|
239
|
+
- [ ] frontmatter 字段符合项目 ID 模式
|
|
240
|
+
- [ ] 审查清单包含项目特定检查项
|
|
241
|
+
- [ ] `artifacts/README.md` 已记录模板来源
|
|
242
|
+
- [ ] `artifact-graph.config.yaml` 已添加类型定义
|
|
243
|
+
- [ ] `artifact-graph validate` 通过
|
|
244
|
+
|
|
245
|
+
### Q: 多个项目可以共享本地模板吗?
|
|
246
|
+
|
|
247
|
+
**A: 可以,但需各自定制。** 每个项目有独立的 `artifact-graph.config.yaml` 和本地模板,即使内容相似,也是各自维护的权威。
|
|
248
|
+
|
|
249
|
+
## 与三层权威模型的关系
|
|
250
|
+
|
|
251
|
+
本指南执行 D-ACA-07 定义的三层权威模型:
|
|
252
|
+
|
|
253
|
+
| 层级 | 对模板的职责 | 本指南动作 |
|
|
254
|
+
|------|------------|-----------|
|
|
255
|
+
| artifact-graph | 从 config 读取类型定义,索引制品 | 更新 config 的 types 和 idPatterns |
|
|
256
|
+
| artifact-chain-assistant | 提供 starter 模板作入门指导 | 复制 starter 到本地 |
|
|
257
|
+
| 目标项目 | 维护本地模板作权威 | 定制模板、记录来源、建立审查规则 |
|
|
258
|
+
|
|
259
|
+
## 相关文档
|
|
260
|
+
|
|
261
|
+
- [templates/extended/README.md](README.md) - Starter 模板目录
|
|
262
|
+
- [扩展制品目录](../../EXTENDED-ARTIFACT-CATALOG.md) - 类型分类、路径/ID 模式、生命周期规则
|
|
263
|
+
- [INSTALL.md](../../INSTALL.md) - 插件安装指南
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
# 扩展制品 Starter 模板
|
|
2
|
+
|
|
3
|
+
本目录包含 `artifact-chain-assistant` 插件为扩展制品类型提供的 **starter 模板**。
|
|
4
|
+
|
|
5
|
+
## 重要声明
|
|
6
|
+
|
|
7
|
+
**这些是 starter 模板,不是项目权威模板。**
|
|
8
|
+
|
|
9
|
+
项目采用后,应:
|
|
10
|
+
1. 复制到项目本地 `artifacts/templates/` 或等价位置
|
|
11
|
+
2. 根据项目需求定制内容
|
|
12
|
+
3. 本地定制后的模板成为项目权威
|
|
13
|
+
4. 插件 starter 仅作入门指导参考
|
|
14
|
+
|
|
15
|
+
## 模板目录
|
|
16
|
+
|
|
17
|
+
### 契约类制品(contracts)
|
|
18
|
+
|
|
19
|
+
- **api_contract** - REST/GraphQL/gRPC API 接口契约
|
|
20
|
+
- 路径:`contracts/api_contract/starter.md`
|
|
21
|
+
- 用途:定义 API 端点、请求/响应格式、错误码
|
|
22
|
+
|
|
23
|
+
- **cli_contract** - 命令行工具接口契约
|
|
24
|
+
- 路径:`contracts/cli_contract/starter.md`
|
|
25
|
+
- 用途:定义 CLI 命令、参数、退出码、配置
|
|
26
|
+
|
|
27
|
+
- **data_contract** - 数据模型和数据质量契约
|
|
28
|
+
- 路径:`contracts/data_contract/starter.md`
|
|
29
|
+
- 用途:定义数据 schema、质量规则、版本兼容性
|
|
30
|
+
|
|
31
|
+
- **ui_contract** - 用户界面交互流程契约
|
|
32
|
+
- 路径:`contracts/ui_contract/starter.md`
|
|
33
|
+
- 用途:定义 UI 流程、状态转换、交互元素、可访问性要求
|
|
34
|
+
- 适用:桌面/全栈、Web/SaaS 应用
|
|
35
|
+
|
|
36
|
+
- **ipc_contract** - 进程间通信契约
|
|
37
|
+
- 路径:`contracts/ipc_contract/starter.md`
|
|
38
|
+
- 用途:定义 IPC 通道、消息格式、前后端边界、序列化规范
|
|
39
|
+
- 适用:桌面/全栈(Tauri/Electron)应用
|
|
40
|
+
|
|
41
|
+
- **report_contract** - 报告生成契约
|
|
42
|
+
- 路径:`contracts/report_contract/starter.md`
|
|
43
|
+
- 用途:定义报告字段、聚合逻辑、输出格式、时间窗口语义
|
|
44
|
+
- 适用:数据平台、BI、企业 Java 项目
|
|
45
|
+
|
|
46
|
+
- **integration_contract** - 外部系统集成契约
|
|
47
|
+
- 路径:`contracts/integration_contract/starter.md`
|
|
48
|
+
- 用途:定义接口协议、超时、重试策略、幂等性、错误分类
|
|
49
|
+
- 适用:企业 Java、微服务、集成平台项目
|
|
50
|
+
|
|
51
|
+
- **batch_job_contract** - 批处理作业契约
|
|
52
|
+
- 路径:`contracts/batch_job_contract/starter.md`
|
|
53
|
+
- 用途:定义输入/输出格式、调度表达式、幂等性、错误处理、重放策略
|
|
54
|
+
- 适用:企业 Java、数据平台项目
|
|
55
|
+
|
|
56
|
+
### 领域与数据制品(domain)
|
|
57
|
+
|
|
58
|
+
- **domain_model** - 领域模型设计
|
|
59
|
+
- 路径:`domain/domain_model/starter.md`
|
|
60
|
+
- 用途:定义聚合边界、领域事件、限界上下文映射、不变量
|
|
61
|
+
|
|
62
|
+
- **database_migration** - 数据库迁移
|
|
63
|
+
- 路径:`domain/database_migration/starter.md`
|
|
64
|
+
- 用途:定义 schema 变更、数据迁移策略、回滚方案、兼容性分析
|
|
65
|
+
- 适用:企业 Java、有状态服务、数据库驱动项目
|
|
66
|
+
|
|
67
|
+
### 部署与运维制品(ops)
|
|
68
|
+
|
|
69
|
+
- **deployment_manifest** - 部署清单
|
|
70
|
+
- 路径:`ops/deployment_manifest/starter.md`
|
|
71
|
+
- 用途:定义环境配置、资源分配、健康检查、回滚计划
|
|
72
|
+
|
|
73
|
+
- **runbook** - 运维操作手册
|
|
74
|
+
- 路径:`ops/runbook/starter.md`
|
|
75
|
+
- 用途:定义运维流程、告警处理、回滚步骤
|
|
76
|
+
|
|
77
|
+
- **security_review** - 安全审查
|
|
78
|
+
- 路径:`ops/security_review/starter.md`
|
|
79
|
+
- 用途:定义威胁模型、安全发现项、修复跟踪、合规映射
|
|
80
|
+
- 适用:企业 Java、安全敏感项目
|
|
81
|
+
|
|
82
|
+
- **performance_budget** - 性能预算
|
|
83
|
+
- 路径:`ops/performance_budget/starter.md`
|
|
84
|
+
- 用途:定义性能指标基线、阈值、回归检测策略、测量方法
|
|
85
|
+
- 适用:性能敏感项目
|
|
86
|
+
|
|
87
|
+
- **migration_plan** - 迁移计划
|
|
88
|
+
- 路径:`ops/migration_plan/starter.md`
|
|
89
|
+
- 用途:定义迁移阶段、回滚点、数据迁移策略、并行运行期
|
|
90
|
+
- 适用:大规模迁移、架构演进项目
|
|
91
|
+
|
|
92
|
+
### 发布治理制品(governance)
|
|
93
|
+
|
|
94
|
+
- **release_policy** - 发布策略
|
|
95
|
+
- 路径:`governance/release_policy/starter.md`
|
|
96
|
+
- 用途:定义版本语义、发布节奏、分支策略、合规要求、回滚方案
|
|
97
|
+
- 适用:Parent/发布治理仓库、多包 monorepo
|
|
98
|
+
|
|
99
|
+
- **publish_skill** - 发布技能
|
|
100
|
+
- 路径:`governance/publish_skill/starter.md`
|
|
101
|
+
- 用途:定义自动化发布流程、注册中心目标、质量门禁、错误处理
|
|
102
|
+
- 适用:Parent/发布治理仓库、CI/CD 集成发布
|
|
103
|
+
|
|
104
|
+
- **oss_compliance** - 开源合规
|
|
105
|
+
- 路径:`governance/oss_compliance/starter.md`
|
|
106
|
+
- 用途:定义许可证策略、依赖审查、发布文件清单、安全披露和发布排除规则
|
|
107
|
+
- 适用:开源项目、Parent/发布治理仓库、多包 monorepo
|
|
108
|
+
|
|
109
|
+
### Agent 与 Hook 制品(agent)
|
|
110
|
+
|
|
111
|
+
- **hook_policy** - Hook 策略和门禁规则
|
|
112
|
+
- 路径:`agent/hook_policy/starter.md`
|
|
113
|
+
- 用途:定义 CI/CD hook 触发条件、门禁规则、绕过审批
|
|
114
|
+
|
|
115
|
+
- **agent_skill** - Agent 技能定义
|
|
116
|
+
- 路径:`agent/agent_skill/starter.md`
|
|
117
|
+
- 用途:定义 Agent 技能的输入/输出契约、处理流程、权限边界
|
|
118
|
+
|
|
119
|
+
- **prompt_packet** - Prompt Packet 上下文包
|
|
120
|
+
- 路径:`agent/prompt_packet/starter.md`
|
|
121
|
+
- 用途:定义 AI 辅助任务的上下文组装、Prompt 模板、Token 预算
|
|
122
|
+
- 适用:Agent/插件工具包、AI 辅助开发流程
|
|
123
|
+
|
|
124
|
+
## 模板使用方式
|
|
125
|
+
|
|
126
|
+
### Bootstrap 阶段
|
|
127
|
+
|
|
128
|
+
1. `artifact-chain-bootstrap` 技能根据项目形态选择最小可用 profile
|
|
129
|
+
2. bootstrap 技能引用本目录的 starter 模板生成初始制品结构
|
|
130
|
+
3. 在 `artifacts/README.md` 中记录模板来源
|
|
131
|
+
|
|
132
|
+
### 采用阶段
|
|
133
|
+
|
|
134
|
+
1. 项目团队审阅 starter 模板
|
|
135
|
+
2. 决定哪些章节保留、哪些修改、哪些删除
|
|
136
|
+
3. 复制到项目本地 `artifacts/templates/` 或等价位置
|
|
137
|
+
4. 修改后的模板成为项目本地权威
|
|
138
|
+
|
|
139
|
+
### 成熟阶段
|
|
140
|
+
|
|
141
|
+
1. 项目在本地维护完整的模板库
|
|
142
|
+
2. 完全不再引用插件 starter
|
|
143
|
+
3. 插件 starter 仅在新成员加入或新类型启用时被参考
|
|
144
|
+
|
|
145
|
+
## 模板内容说明
|
|
146
|
+
|
|
147
|
+
### starter.md
|
|
148
|
+
|
|
149
|
+
每个类型的 `starter.md` 包含:
|
|
150
|
+
- 制品 frontmatter 结构(id, title, status, version 等)
|
|
151
|
+
- 最小填写指引
|
|
152
|
+
- 关键章节说明
|
|
153
|
+
- 关联制品示例
|
|
154
|
+
|
|
155
|
+
**使用建议**:
|
|
156
|
+
- 复制到项目本地后修改
|
|
157
|
+
- 根据项目需求调整章节
|
|
158
|
+
- 删除不适用的章节
|
|
159
|
+
- 添加项目特定的章节
|
|
160
|
+
|
|
161
|
+
### review-checklist.md
|
|
162
|
+
|
|
163
|
+
每个类型的 `review-checklist.md` 包含:
|
|
164
|
+
- 结构完整性检查
|
|
165
|
+
- 内容质量检查
|
|
166
|
+
- 追溯性检查
|
|
167
|
+
- 生命周期检查
|
|
168
|
+
|
|
169
|
+
**使用建议**:
|
|
170
|
+
- 作为审查基线参考
|
|
171
|
+
- 根据项目标准调整检查项
|
|
172
|
+
- 添加项目特定的检查项
|
|
173
|
+
- 在审查技能中引用
|
|
174
|
+
|
|
175
|
+
## Bootstrap 裁剪策略
|
|
176
|
+
|
|
177
|
+
bootstrap 的职责是根据项目形态选择**最小可用 profile**,而非启用所有已知类型。
|
|
178
|
+
|
|
179
|
+
裁剪规则:
|
|
180
|
+
|
|
181
|
+
1. **基础集合始终启用**:`feature`、`scenario`、`decision`、`design`、`test`、`e2e_test`
|
|
182
|
+
2. **契约类按证据加入**:仅当项目本地存在对应的接口文件时启用
|
|
183
|
+
3. **领域与数据类按项目形态加入**:企业 Java/DDD 项目可启用 `domain_model`;有数据库的项目可启用 `database_migration`
|
|
184
|
+
4. **运维类按运维流程加入**:仅有部署配置文件、安全审查流程、性能管理需求或迁移计划的项目才启用对应类型
|
|
185
|
+
5. **Agent/Hook 类按本地文件加入**:仅当项目存在 `skills/`、`policies/` 或 hook 配置文件时启用
|
|
186
|
+
6. **发布治理类按治理需求加入**:仅当项目是 Parent/发布治理仓库且有发布流程或开源合规文件时启用 `release_policy`、`publish_skill`、`oss_compliance`
|
|
187
|
+
7. **渐进扩展**:项目随成熟度增长,可按需添加新类型
|
|
188
|
+
|
|
189
|
+
## 扩展制品目录设计
|
|
190
|
+
|
|
191
|
+
本目录的模板结构遵循扩展制品目录规范:
|
|
192
|
+
|
|
193
|
+
- 模板目录按类别组织(contracts、domain、ops、governance、agent),每类含 starter.md 和 review-checklist.md
|
|
194
|
+
- 模板来源遵循权威层级:插件模板是入门指导,项目本地模板是权威
|
|
195
|
+
- Bootstrap 按项目形态裁剪,仅启用有本地证据的类型
|
|
196
|
+
- 模板生命周期:starter → 项目采用定制 → 本地权威
|
|
197
|
+
|
|
198
|
+
详细的类型目录、推荐路径、ID 模式和生命周期规则,请参考
|
|
199
|
+
[扩展制品目录](../../EXTENDED-ARTIFACT-CATALOG.md)。
|
|
200
|
+
|
|
201
|
+
## 插件版本升级时的模板同步
|
|
202
|
+
|
|
203
|
+
当 `artifact-chain-assistant` 发布新版本且包含新的 starter 模板时,已采用项目的同步流程:
|
|
204
|
+
|
|
205
|
+
### 发现新模板
|
|
206
|
+
|
|
207
|
+
1. 查看 `CHANGELOG.md` 中的"Extended templates"部分
|
|
208
|
+
2. 浏览 `templates/extended/` 目录,对比项目本地 `artifacts/templates/`
|
|
209
|
+
3. 确认哪些新类型对当前项目形态有用
|
|
210
|
+
|
|
211
|
+
### 同步步骤
|
|
212
|
+
|
|
213
|
+
**步骤 1:评估相关性**
|
|
214
|
+
|
|
215
|
+
根据项目形态决定是否需要新模板:
|
|
216
|
+
|
|
217
|
+
| 项目形态 | 可能相关的新模板 |
|
|
218
|
+
|----------|-----------------|
|
|
219
|
+
| API 服务 | `api_contract`, `data_contract`, `runbook`, `performance_budget` |
|
|
220
|
+
| CLI/库 | `cli_contract` |
|
|
221
|
+
| 企业 Java | 所有契约类、`domain_model`, `database_migration`, `deployment_manifest`, `security_review`, `runbook` |
|
|
222
|
+
| Agent/插件 | `agent_skill`, `hook_policy`, `prompt_packet` |
|
|
223
|
+
| Parent/发布治理 | `release_policy`, `publish_skill`, `oss_compliance` |
|
|
224
|
+
| 数据平台 | `data_contract`, `batch_job_contract`, `report_contract`, `database_migration` |
|
|
225
|
+
| 大规模迁移 | `migration_plan`, `database_migration`, `deployment_manifest` |
|
|
226
|
+
|
|
227
|
+
**步骤 2:复制到项目本地**
|
|
228
|
+
|
|
229
|
+
```bash
|
|
230
|
+
# 示例:复制 api_contract starter
|
|
231
|
+
cp plugins/artifact-chain-assistant/templates/extended/contracts/api_contract/starter.md \
|
|
232
|
+
artifacts/templates/api_contract.md
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
**步骤 3:定制内容**
|
|
236
|
+
|
|
237
|
+
- 删除不适用的章节
|
|
238
|
+
- 添加项目特定的字段或检查项
|
|
239
|
+
- 调整 frontmatter 字段以匹配项目 ID 模式
|
|
240
|
+
- 添加本地审查规则
|
|
241
|
+
|
|
242
|
+
**步骤 4:记录模板来源**
|
|
243
|
+
|
|
244
|
+
在 `artifacts/README.md` 或项目模板目录的 README 中记录:
|
|
245
|
+
- 模板来源:插件 `templates/extended/`
|
|
246
|
+
- 定制日期和版本
|
|
247
|
+
- 本地修改摘要
|
|
248
|
+
|
|
249
|
+
### 重要规则
|
|
250
|
+
|
|
251
|
+
- **不要直接引用插件 starter**:复制到项目本地后定制
|
|
252
|
+
- **本地定制后覆盖插件**:项目本地模板成为权威,插件 starter 仅作参考
|
|
253
|
+
- **不自动同步**:插件更新不自动覆盖项目本地模板,需手动评估和复制
|
|
254
|
+
|
|
255
|
+
## 相关文档
|
|
256
|
+
|
|
257
|
+
- [templates/README.md](../README.md) - 模板目录总览
|
|
258
|
+
- [ADOPTION-GUIDE.md](ADOPTION-GUIDE.md) - **采用指南**:如何将 starter 模板定制为项目本地权威模板,以及升级评审流程
|
|
259
|
+
- [扩展制品目录](../../EXTENDED-ARTIFACT-CATALOG.md) - 类型分类、路径/ID 模式、生命周期规则
|
|
260
|
+
- [INSTALL.md](../../INSTALL.md) - 插件安装指南(含升级指南)
|
|
261
|
+
- [artifact-chain-bootstrap 技能](../../skills/artifact-chain-bootstrap/SKILL.md) - Bootstrap 技能文档
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Agent Skill 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `SKILL-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述技能功能
|
|
9
|
+
- [ ] 触发条件明确
|
|
10
|
+
- [ ] 适用场景已定义
|
|
11
|
+
|
|
12
|
+
## 输入/输出质量
|
|
13
|
+
|
|
14
|
+
- [ ] 必需输入参数完整
|
|
15
|
+
- [ ] 参数类型和描述明确
|
|
16
|
+
- [ ] 输出格式定义完整
|
|
17
|
+
- [ ] 错误输出有标准格式
|
|
18
|
+
|
|
19
|
+
## 处理流程
|
|
20
|
+
|
|
21
|
+
- [ ] 处理步骤清晰
|
|
22
|
+
- [ ] 每个步骤有明确输入/输出
|
|
23
|
+
- [ ] 错误处理路径已定义
|
|
24
|
+
- [ ] 边界条件已考虑
|
|
25
|
+
|
|
26
|
+
## 工具依赖
|
|
27
|
+
|
|
28
|
+
- [ ] 工具依赖已列出
|
|
29
|
+
- [ ] 权限要求明确
|
|
30
|
+
- [ ] 工具调用有错误处理
|
|
31
|
+
- [ ] 无循环依赖
|
|
32
|
+
|
|
33
|
+
## 权限安全
|
|
34
|
+
|
|
35
|
+
- [ ] 可访问资源已定义
|
|
36
|
+
- [ ] 禁止操作已列出
|
|
37
|
+
- [ ] 数据访问范围合理
|
|
38
|
+
- [ ] 敏感操作有审批
|
|
39
|
+
|
|
40
|
+
## 追溯性
|
|
41
|
+
|
|
42
|
+
- [ ] 关联功能特性存在
|
|
43
|
+
- [ ] 关联决策存在
|
|
44
|
+
- [ ] 技能可追溯到用户需求
|
|
45
|
+
|
|
46
|
+
## 可测试性
|
|
47
|
+
|
|
48
|
+
- [ ] 示例输入/输出完整
|
|
49
|
+
- [ ] 测试用例覆盖正常路径
|
|
50
|
+
- [ ] 测试用例覆盖异常路径
|
|
51
|
+
- [ ] 边界条件已测试
|