@rosetears/aili-pi 0.1.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/LICENSE +21 -0
- package/README.md +109 -0
- package/THIRD_PARTY_NOTICES.md +64 -0
- package/extensions/index.ts +6 -0
- package/install.sh +5 -0
- package/manifests/adapter-evidence.json +45 -0
- package/manifests/capabilities.json +124 -0
- package/manifests/live-verification.json +26 -0
- package/manifests/provenance.json +71 -0
- package/manifests/roles.json +474 -0
- package/manifests/sbom.json +7797 -0
- package/manifests/skill-compatibility.json +8100 -0
- package/manifests/subagent-provenance.json +37 -0
- package/package.json +91 -0
- package/prompts/build.md +8 -0
- package/prompts/define.md +8 -0
- package/prompts/ideate.md +8 -0
- package/prompts/local-review.md +8 -0
- package/prompts/ship.md +8 -0
- package/roles/agent-evaluator.md +47 -0
- package/roles/ai-regression-scout.md +47 -0
- package/roles/browser-qa-runner.md +47 -0
- package/roles/code-reviewer.md +47 -0
- package/roles/code-scout.md +47 -0
- package/roles/convergence-reviewer.md +55 -0
- package/roles/doc-researcher.md +47 -0
- package/roles/e2e-artifact-runner.md +47 -0
- package/roles/implementer.md +47 -0
- package/roles/opensource-sanitizer.md +47 -0
- package/roles/plan-auditor.md +47 -0
- package/roles/pr-test-analyzer.md +47 -0
- package/roles/security-auditor.md +47 -0
- package/roles/silent-failure-reviewer.md +47 -0
- package/roles/spec-miner.md +47 -0
- package/roles/test-coverage-reviewer.md +47 -0
- package/roles/test-engineer.md +48 -0
- package/roles/web-performance-auditor.md +47 -0
- package/roles/web-researcher.md +47 -0
- package/scripts/apply-adapter-evidence.ts +73 -0
- package/scripts/bootstrap.sh +180 -0
- package/scripts/generate-provenance.ts +143 -0
- package/scripts/local-package-e2e.ts +51 -0
- package/scripts/sync-roles.ts +213 -0
- package/scripts/sync-skills.ts +356 -0
- package/scripts/validate-runtime.ts +11 -0
- package/skills/academic-paper-review/SKILL.md +81 -0
- package/skills/agents-md-initialization/SKILL.md +121 -0
- package/skills/agents-md-initialization/references/agents-template.md +83 -0
- package/skills/agents-md-initialization/references/agents_md.py +215 -0
- package/skills/ai-regression-scout/SKILL.md +24 -0
- package/skills/aili-delivery-flow/SKILL.md +125 -0
- package/skills/aili-delivery-flow/references/artifact-contracts.md +138 -0
- package/skills/aili-delivery-flow/references/backend-routing.md +40 -0
- package/skills/aili-delivery-flow/references/build-execution-loop.md +113 -0
- package/skills/aili-delivery-flow/references/build-goal-mode.md +3 -0
- package/skills/aili-delivery-flow/references/direct-vs-delegated-work.md +38 -0
- package/skills/aili-delivery-flow/references/implementation-packages.md +54 -0
- package/skills/aili-delivery-flow/references/lifecycle.md +127 -0
- package/skills/aili-delivery-flow/references/protocols/acceptance-test-plan.md +18 -0
- package/skills/aili-delivery-flow/references/protocols/alignment-questionnaire.md +10 -0
- package/skills/aili-delivery-flow/references/protocols/closeout-report.md +101 -0
- package/skills/aili-delivery-flow/references/protocols/compact-evidence-pack.md +46 -0
- package/skills/aili-delivery-flow/references/protocols/idea-brief.md +10 -0
- package/skills/aili-delivery-flow/references/protocols/implementation-package.md +53 -0
- package/skills/aili-delivery-flow/references/protocols/research-evidence-pack.md +19 -0
- package/skills/aili-delivery-flow/references/protocols/review-report.md +7 -0
- package/skills/aili-delivery-flow/references/protocols/spec-draft.md +12 -0
- package/skills/aili-delivery-flow/references/protocols/subagent-result.md +60 -0
- package/skills/aili-delivery-flow/references/protocols/subagent-task-packet.md +29 -0
- package/skills/aili-delivery-flow/references/protocols/worktree-context.md +109 -0
- package/skills/aili-delivery-flow/references/questionnaire-policy.md +62 -0
- package/skills/aili-delivery-flow/references/review-repair-loop.md +16 -0
- package/skills/aili-delivery-flow/references/test-document-policy.md +35 -0
- package/skills/android-native-dev/SKILL.md +722 -0
- package/skills/android-native-dev/references/accessibility.md +209 -0
- package/skills/android-native-dev/references/adaptive-screens.md +231 -0
- package/skills/android-native-dev/references/design-style-guide.md +365 -0
- package/skills/android-native-dev/references/functional-requirements.md +229 -0
- package/skills/android-native-dev/references/motion-system.md +203 -0
- package/skills/android-native-dev/references/performance-stability.md +223 -0
- package/skills/android-native-dev/references/privacy-security.md +244 -0
- package/skills/android-native-dev/references/testing.md +554 -0
- package/skills/android-native-dev/references/visual-design.md +246 -0
- package/skills/api-and-interface-design/SKILL.md +318 -0
- package/skills/browser-qa/SKILL.md +32 -0
- package/skills/browser-testing-with-devtools/SKILL.md +323 -0
- package/skills/build-failure-repair/SKILL.md +49 -0
- package/skills/chart-visualization/SKILL.md +73 -0
- package/skills/ci-cd-and-automation/SKILL.md +353 -0
- package/skills/code-review-and-quality/SKILL.md +375 -0
- package/skills/code-review-quality-gates/SKILL.md +132 -0
- package/skills/code-simplification/SKILL.md +371 -0
- package/skills/comment-accuracy-review/SKILL.md +37 -0
- package/skills/consulting-analysis/SKILL.md +69 -0
- package/skills/context-engineering/SKILL.md +375 -0
- package/skills/coverage-review/SKILL.md +24 -0
- package/skills/data-analysis/SKILL.md +74 -0
- package/skills/deprecation-and-migration/SKILL.md +222 -0
- package/skills/documentation-and-adrs/SKILL.md +330 -0
- package/skills/e2e-artifact-handling/SKILL.md +30 -0
- package/skills/evidence-scoped-retrospective/SKILL.md +156 -0
- package/skills/explain-by-allegory/SKILL.md +99 -0
- package/skills/flutter-dev/SKILL.md +162 -0
- package/skills/flutter-dev/references/animations.md +497 -0
- package/skills/flutter-dev/references/bloc-state.md +281 -0
- package/skills/flutter-dev/references/forms.md +656 -0
- package/skills/flutter-dev/references/gorouter-navigation.md +257 -0
- package/skills/flutter-dev/references/localization.md +510 -0
- package/skills/flutter-dev/references/networking.md +566 -0
- package/skills/flutter-dev/references/performance.md +305 -0
- package/skills/flutter-dev/references/platform-specific.md +417 -0
- package/skills/flutter-dev/references/project-structure.md +273 -0
- package/skills/flutter-dev/references/riverpod-state.md +232 -0
- package/skills/flutter-dev/references/testing.md +364 -0
- package/skills/flutter-dev/references/widget-patterns.md +233 -0
- package/skills/frontend-dev/SKILL.md +468 -0
- package/skills/frontend-dev/canvas-fonts/ArsenalSC-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/ArsenalSC-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/BigShoulders-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/BigShoulders-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/BigShoulders-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Boldonse-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Boldonse-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/BricolageGrotesque-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/BricolageGrotesque-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/BricolageGrotesque-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/CrimsonPro-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/CrimsonPro-Italic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/CrimsonPro-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/CrimsonPro-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/DMMono-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/DMMono-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/EricaOne-OFL.txt +94 -0
- package/skills/frontend-dev/canvas-fonts/EricaOne-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/GeistMono-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/GeistMono-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/GeistMono-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Gloock-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Gloock-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/IBMPlexMono-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/IBMPlexMono-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/IBMPlexMono-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/IBMPlexSerif-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/IBMPlexSerif-BoldItalic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/IBMPlexSerif-Italic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/IBMPlexSerif-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/InstrumentSans-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/InstrumentSans-BoldItalic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/InstrumentSans-Italic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/InstrumentSans-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/InstrumentSans-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/InstrumentSerif-Italic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/InstrumentSerif-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Italiana-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Italiana-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/JetBrainsMono-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/JetBrainsMono-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/JetBrainsMono-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Jura-Light.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Jura-Medium.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Jura-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/LibreBaskerville-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/LibreBaskerville-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Lora-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Lora-BoldItalic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Lora-Italic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Lora-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Lora-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/NationalPark-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/NationalPark-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/NationalPark-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/NothingYouCouldDo-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/NothingYouCouldDo-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Outfit-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Outfit-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Outfit-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/PixelifySans-Medium.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/PixelifySans-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/PoiretOne-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/PoiretOne-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/RedHatMono-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/RedHatMono-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/RedHatMono-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Silkscreen-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Silkscreen-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/SmoochSans-Medium.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/SmoochSans-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Tektur-Medium.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/Tektur-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/Tektur-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/WorkSans-Bold.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/WorkSans-BoldItalic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/WorkSans-Italic.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/WorkSans-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/WorkSans-Regular.ttf +0 -0
- package/skills/frontend-dev/canvas-fonts/YoungSerif-OFL.txt +93 -0
- package/skills/frontend-dev/canvas-fonts/YoungSerif-Regular.ttf +0 -0
- package/skills/frontend-dev/references/asset-prompt-guide.md +43 -0
- package/skills/frontend-dev/references/env-setup.md +33 -0
- package/skills/frontend-dev/references/minimax-cli-reference.md +133 -0
- package/skills/frontend-dev/references/minimax-image-guide.md +65 -0
- package/skills/frontend-dev/references/minimax-music-guide.md +216 -0
- package/skills/frontend-dev/references/minimax-tts-guide.md +78 -0
- package/skills/frontend-dev/references/minimax-video-guide.md +82 -0
- package/skills/frontend-dev/references/minimax-voice-catalog.md +685 -0
- package/skills/frontend-dev/references/motion-recipes.md +407 -0
- package/skills/frontend-dev/references/troubleshooting.md +85 -0
- package/skills/frontend-dev/scripts/minimax_image.py +137 -0
- package/skills/frontend-dev/scripts/minimax_music.py +157 -0
- package/skills/frontend-dev/scripts/minimax_tts.py +127 -0
- package/skills/frontend-dev/scripts/minimax_video.py +187 -0
- package/skills/frontend-dev/templates/generator_template.js +223 -0
- package/skills/frontend-dev/templates/viewer.html +599 -0
- package/skills/frontend-ui-engineering/SKILL.md +367 -0
- package/skills/fullstack-dev/SKILL.md +819 -0
- package/skills/fullstack-dev/references/api-design.md +444 -0
- package/skills/fullstack-dev/references/auth-flow.md +165 -0
- package/skills/fullstack-dev/references/db-schema.md +706 -0
- package/skills/fullstack-dev/references/django-best-practices.md +466 -0
- package/skills/fullstack-dev/references/environment-management.md +78 -0
- package/skills/fullstack-dev/references/release-checklist.md +278 -0
- package/skills/fullstack-dev/references/technology-selection.md +254 -0
- package/skills/fullstack-dev/references/testing-strategy.md +404 -0
- package/skills/git-workflow-and-versioning/SKILL.md +446 -0
- package/skills/github-evidence-triage/SKILL.md +115 -0
- package/skills/harness-evolution/SKILL.md +59 -0
- package/skills/harness-evolution/references/activation-matrix.md +13 -0
- package/skills/harness-evolution/references/approval-policy.md +20 -0
- package/skills/harness-evolution/references/change-report-template.md +33 -0
- package/skills/harness-evolution/references/component-taxonomy.md +19 -0
- package/skills/harness-evolution/references/verdict-policy.md +13 -0
- package/skills/harness-issue-triage/SKILL.md +72 -0
- package/skills/harness-issue-triage/references/component-diagnosis.md +25 -0
- package/skills/harness-issue-triage/references/triage-report-template.md +34 -0
- package/skills/harness-optimization-audit/SKILL.md +125 -0
- package/skills/idea-refine/SKILL.md +191 -0
- package/skills/idea-refine/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/LICENSE +21 -0
- package/skills/idea-refine/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/NOTICE.md +9 -0
- package/skills/idea-refine/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/idea-refine/SKILL.upstream.md +178 -0
- package/skills/idea-refine/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/idea-refine/examples.md +238 -0
- package/skills/idea-refine/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/idea-refine/frameworks.md +99 -0
- package/skills/idea-refine/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/idea-refine/refinement-criteria.md +113 -0
- package/skills/idea-refine/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/idea-refine/scripts/idea-refine.upstream.sh +15 -0
- package/skills/incremental-implementation/SKILL.md +252 -0
- package/skills/ios-application-dev/SKILL.md +212 -0
- package/skills/ios-application-dev/references/accessibility.md +259 -0
- package/skills/ios-application-dev/references/graphics-animation.md +350 -0
- package/skills/ios-application-dev/references/layout-system.md +199 -0
- package/skills/ios-application-dev/references/metal-shader.md +178 -0
- package/skills/ios-application-dev/references/navigation-patterns.md +175 -0
- package/skills/ios-application-dev/references/swift-coding-standards.md +757 -0
- package/skills/ios-application-dev/references/swiftui-design-guidelines.md +1167 -0
- package/skills/ios-application-dev/references/system-integration.md +401 -0
- package/skills/ios-application-dev/references/uikit-components.md +297 -0
- package/skills/local-review-gate/SKILL.md +207 -0
- package/skills/local-review-gate/references/addyosmani-code-review-rubric.md +33 -0
- package/skills/local-review-gate/references/codex-github-compatibility.md +26 -0
- package/skills/local-review-gate/references/ecc-code-review-adaptation.md +40 -0
- package/skills/local-review-gate/references/graphify-local-review.md +33 -0
- package/skills/local-review-gate/references/orchestration-adaptation.md +51 -0
- package/skills/local-review-gate/references/review-repair-lane-adaptation.md +46 -0
- package/skills/local-review-gate/references/upstream-provenance.md +61 -0
- package/skills/mature-project-pattern-research/SKILL.md +155 -0
- package/skills/mature-project-pattern-research/references/research-rubric.md +45 -0
- package/skills/minimax-docx/LICENSE +21 -0
- package/skills/minimax-docx/SKILL.md +273 -0
- package/skills/minimax-docx/assets/styles/academic_styles.xml +250 -0
- package/skills/minimax-docx/assets/styles/corporate_styles.xml +284 -0
- package/skills/minimax-docx/assets/styles/default_styles.xml +449 -0
- package/skills/minimax-docx/assets/xsd/aesthetic-rules.xsd +470 -0
- package/skills/minimax-docx/assets/xsd/business-rules.xsd +130 -0
- package/skills/minimax-docx/assets/xsd/common-types.xsd +159 -0
- package/skills/minimax-docx/assets/xsd/wml-subset.xsd +589 -0
- package/skills/minimax-docx/references/cjk_typography.md +357 -0
- package/skills/minimax-docx/references/cjk_university_template_guide.md +184 -0
- package/skills/minimax-docx/references/comments_guide.md +191 -0
- package/skills/minimax-docx/references/design_good_bad_examples.md +829 -0
- package/skills/minimax-docx/references/design_principles.md +819 -0
- package/skills/minimax-docx/references/openxml_element_order.md +308 -0
- package/skills/minimax-docx/references/openxml_encyclopedia_part1.md +4061 -0
- package/skills/minimax-docx/references/openxml_encyclopedia_part2.md +2820 -0
- package/skills/minimax-docx/references/openxml_encyclopedia_part3.md +3381 -0
- package/skills/minimax-docx/references/openxml_namespaces.md +82 -0
- package/skills/minimax-docx/references/openxml_units.md +72 -0
- package/skills/minimax-docx/references/scenario_a_create.md +284 -0
- package/skills/minimax-docx/references/scenario_b_edit_content.md +295 -0
- package/skills/minimax-docx/references/scenario_c_apply_template.md +456 -0
- package/skills/minimax-docx/references/track_changes_guide.md +200 -0
- package/skills/minimax-docx/references/troubleshooting.md +506 -0
- package/skills/minimax-docx/references/typography_guide.md +294 -0
- package/skills/minimax-docx/references/xsd_validation_guide.md +158 -0
- package/skills/minimax-docx/scripts/doc_to_docx.sh +40 -0
- package/skills/minimax-docx/scripts/docx_preview.sh +37 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Cli/MiniMaxAIDocx.Cli.csproj +19 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Cli/Program.cs +18 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/AnalyzeCommand.cs +147 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/ApplyTemplateCommand.cs +322 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/CreateCommand.cs +324 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/DiffCommand.cs +155 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/EditContentCommand.cs +487 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/FixOrderCommand.cs +108 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/MergeRunsCommand.cs +122 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Commands/ValidateCommand.cs +107 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/MiniMaxAIDocx.Core.csproj +15 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/OpenXml/CommentSynchronizer.cs +169 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/OpenXml/ElementOrder.cs +80 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/OpenXml/NamespaceConstants.cs +42 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/OpenXml/RunMerger.cs +81 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/OpenXml/StyleAnalyzer.cs +81 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/OpenXml/TrackChangesHelper.cs +99 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/OpenXml/UnitConverter.cs +23 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/AestheticRecipeSamples.cs +1832 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/AestheticRecipeSamples_Batch1.cs +910 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/AestheticRecipeSamples_Batch2.cs +999 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/AestheticRecipeSamples_Batch3.cs +1048 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/AestheticRecipeSamples_Batch4.cs +1038 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/CharacterFormattingSamples.cs +1020 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/DocumentCreationSamples.cs +1121 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/FieldAndTocSamples.cs +624 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/FootnoteAndCommentSamples.cs +675 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/HeaderFooterSamples.cs +838 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/ImageSamples.cs +917 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/ListAndNumberingSamples.cs +826 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/ParagraphFormattingSamples.cs +1199 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/StyleSystemSamples.cs +1487 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/TableSamples.cs +1163 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Samples/TrackChangesSamples.cs +595 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Typography/CjkHelper.cs +39 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Typography/FontDefaults.cs +24 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Typography/PageSizes.cs +20 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Validation/BusinessRuleValidator.cs +224 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Validation/GateCheckValidator.cs +148 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Validation/ValidationResult.cs +23 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.Core/Validation/XsdValidator.cs +69 -0
- package/skills/minimax-docx/scripts/dotnet/MiniMaxAIDocx.slnx +4 -0
- package/skills/minimax-docx/scripts/env_check.sh +196 -0
- package/skills/minimax-docx/scripts/setup.ps1 +274 -0
- package/skills/minimax-docx/scripts/setup.sh +504 -0
- package/skills/minimax-pdf/README.md +222 -0
- package/skills/minimax-pdf/SKILL.md +218 -0
- package/skills/minimax-pdf/design/design.md +381 -0
- package/skills/minimax-pdf/scripts/cover.py +1579 -0
- package/skills/minimax-pdf/scripts/fill_inspect.py +200 -0
- package/skills/minimax-pdf/scripts/fill_write.py +242 -0
- package/skills/minimax-pdf/scripts/make.sh +491 -0
- package/skills/minimax-pdf/scripts/merge.py +112 -0
- package/skills/minimax-pdf/scripts/palette.py +521 -0
- package/skills/minimax-pdf/scripts/reformat_parse.py +374 -0
- package/skills/minimax-pdf/scripts/render_body.py +1052 -0
- package/skills/minimax-pdf/scripts/render_cover.js +111 -0
- package/skills/minimax-xlsx/SKILL.md +156 -0
- package/skills/minimax-xlsx/references/create.md +691 -0
- package/skills/minimax-xlsx/references/edit.md +684 -0
- package/skills/minimax-xlsx/references/fix.md +37 -0
- package/skills/minimax-xlsx/references/format.md +768 -0
- package/skills/minimax-xlsx/references/ooxml-cheatsheet.md +231 -0
- package/skills/minimax-xlsx/references/read-analyze.md +97 -0
- package/skills/minimax-xlsx/references/validate.md +772 -0
- package/skills/minimax-xlsx/scripts/formula_check.py +422 -0
- package/skills/minimax-xlsx/scripts/libreoffice_recalc.py +248 -0
- package/skills/minimax-xlsx/scripts/shared_strings_builder.py +163 -0
- package/skills/minimax-xlsx/scripts/style_audit.py +575 -0
- package/skills/minimax-xlsx/scripts/xlsx_add_column.py +395 -0
- package/skills/minimax-xlsx/scripts/xlsx_insert_row.py +274 -0
- package/skills/minimax-xlsx/scripts/xlsx_pack.py +87 -0
- package/skills/minimax-xlsx/scripts/xlsx_reader.py +362 -0
- package/skills/minimax-xlsx/scripts/xlsx_shift_rows.py +396 -0
- package/skills/minimax-xlsx/scripts/xlsx_unpack.py +130 -0
- package/skills/minimax-xlsx/templates/minimal_xlsx/[Content_Types].xml +9 -0
- package/skills/minimax-xlsx/templates/minimal_xlsx/_rels/.rels +6 -0
- package/skills/minimax-xlsx/templates/minimal_xlsx/xl/_rels/workbook.xml.rels +19 -0
- package/skills/minimax-xlsx/templates/minimal_xlsx/xl/sharedStrings.xml +33 -0
- package/skills/minimax-xlsx/templates/minimal_xlsx/xl/styles.xml +160 -0
- package/skills/minimax-xlsx/templates/minimal_xlsx/xl/workbook.xml +30 -0
- package/skills/minimax-xlsx/templates/minimal_xlsx/xl/worksheets/sheet1.xml +70 -0
- package/skills/newsletter-generation/SKILL.md +71 -0
- package/skills/oss-release-readiness/SKILL.md +47 -0
- package/skills/parallel-subagent-dispatch/SKILL.md +58 -0
- package/skills/performance-optimization/SKILL.md +364 -0
- package/skills/planning-and-task-breakdown/SKILL.md +290 -0
- package/skills/pptx-generator/SKILL.md +275 -0
- package/skills/pptx-generator/references/design-system.md +392 -0
- package/skills/pptx-generator/references/editing.md +162 -0
- package/skills/pptx-generator/references/pitfalls.md +112 -0
- package/skills/pptx-generator/references/pptxgenjs.md +420 -0
- package/skills/pptx-generator/references/slide-types.md +413 -0
- package/skills/pr-test-analysis/SKILL.md +24 -0
- package/skills/react-native-dev/SKILL.md +180 -0
- package/skills/react-native-dev/references/animations.md +254 -0
- package/skills/react-native-dev/references/components.md +124 -0
- package/skills/react-native-dev/references/engineering.md +527 -0
- package/skills/react-native-dev/references/forms.md +300 -0
- package/skills/react-native-dev/references/native-capabilities.md +163 -0
- package/skills/react-native-dev/references/navigation.md +271 -0
- package/skills/react-native-dev/references/networking.md +346 -0
- package/skills/react-native-dev/references/performance.md +215 -0
- package/skills/react-native-dev/references/state-management.md +230 -0
- package/skills/react-native-dev/references/styling.md +117 -0
- package/skills/react-native-dev/references/testing.md +341 -0
- package/skills/requirements-grilling/SKILL.md +447 -0
- package/skills/requirements-grilling/references/ADR-FORMAT.md +46 -0
- package/skills/requirements-grilling/references/CONTEXT-FORMAT.md +41 -0
- package/skills/requirements-grilling/references/INTERVIEW-PACKET-FORMAT.md +62 -0
- package/skills/requirements-grilling/references/MIT-LICENSE-MATT-POCOCK.md +25 -0
- package/skills/requirements-grilling/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/LICENSE +21 -0
- package/skills/requirements-grilling/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/NOTICE.md +9 -0
- package/skills/requirements-grilling/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/interview-me/SKILL.upstream.md +225 -0
- package/skills/requirements-grilling/references/upstream/mattpocock-skills/9603c1cc8118d08bc1b3bf34cf714f62178dea3b/LICENSE +21 -0
- package/skills/requirements-grilling/references/upstream/mattpocock-skills/9603c1cc8118d08bc1b3bf34cf714f62178dea3b/NOTICE.md +12 -0
- package/skills/requirements-grilling/references/upstream/mattpocock-skills/9603c1cc8118d08bc1b3bf34cf714f62178dea3b/batch-grill-me/SKILL.upstream.md +15 -0
- package/skills/requirements-grilling/references/upstream/mattpocock-skills/9603c1cc8118d08bc1b3bf34cf714f62178dea3b/grill-me/SKILL.upstream.md +7 -0
- package/skills/requirements-grilling/references/upstream/mattpocock-skills/9603c1cc8118d08bc1b3bf34cf714f62178dea3b/grilling/SKILL.upstream.md +12 -0
- package/skills/review-pipeline/SKILL.md +38 -0
- package/skills/rose-memory/SKILL.md +210 -0
- package/skills/rose-memory/references/README.md +48 -0
- package/skills/rose-memory/references/memory_cli.py +2384 -0
- package/skills/rose-memory/references/schema.sql +315 -0
- package/skills/security-and-hardening/SKILL.md +369 -0
- package/skills/session-handoff/SKILL.md +88 -0
- package/skills/session-handoff/references/upstream/mattpocock-skills/391a2701dd948f94f56a39f7533f8eea9a859c87/LICENSE +21 -0
- package/skills/session-handoff/references/upstream/mattpocock-skills/391a2701dd948f94f56a39f7533f8eea9a859c87/NOTICE.md +9 -0
- package/skills/session-handoff/references/upstream/mattpocock-skills/391a2701dd948f94f56a39f7533f8eea9a859c87/productivity/handoff/SKILL.upstream.md +16 -0
- package/skills/session-handoff/scripts/session_handoff.py +764 -0
- package/skills/shader-dev/SKILL.md +316 -0
- package/skills/shader-dev/reference/ambient-occlusion.md +382 -0
- package/skills/shader-dev/reference/analytic-ray-tracing.md +651 -0
- package/skills/shader-dev/reference/anti-aliasing.md +71 -0
- package/skills/shader-dev/reference/atmospheric-scattering.md +571 -0
- package/skills/shader-dev/reference/camera-effects.md +80 -0
- package/skills/shader-dev/reference/cellular-automata.md +635 -0
- package/skills/shader-dev/reference/color-palette.md +481 -0
- package/skills/shader-dev/reference/csg-boolean-operations.md +466 -0
- package/skills/shader-dev/reference/domain-repetition.md +436 -0
- package/skills/shader-dev/reference/domain-warping.md +419 -0
- package/skills/shader-dev/reference/fluid-simulation.md +425 -0
- package/skills/shader-dev/reference/fractal-rendering.md +525 -0
- package/skills/shader-dev/reference/lighting-model.md +639 -0
- package/skills/shader-dev/reference/matrix-transform.md +535 -0
- package/skills/shader-dev/reference/multipass-buffer.md +571 -0
- package/skills/shader-dev/reference/normal-estimation.md +418 -0
- package/skills/shader-dev/reference/particle-system.md +589 -0
- package/skills/shader-dev/reference/path-tracing-gi.md +602 -0
- package/skills/shader-dev/reference/polar-uv-manipulation.md +521 -0
- package/skills/shader-dev/reference/post-processing.md +375 -0
- package/skills/shader-dev/reference/procedural-2d-pattern.md +439 -0
- package/skills/shader-dev/reference/procedural-noise.md +551 -0
- package/skills/shader-dev/reference/ray-marching.md +396 -0
- package/skills/shader-dev/reference/sdf-2d.md +724 -0
- package/skills/shader-dev/reference/sdf-3d.md +805 -0
- package/skills/shader-dev/reference/sdf-tricks.md +63 -0
- package/skills/shader-dev/reference/shadow-techniques.md +476 -0
- package/skills/shader-dev/reference/simulation-physics.md +644 -0
- package/skills/shader-dev/reference/sound-synthesis.md +578 -0
- package/skills/shader-dev/reference/terrain-rendering.md +839 -0
- package/skills/shader-dev/reference/texture-mapping-advanced.md +87 -0
- package/skills/shader-dev/reference/texture-sampling.md +553 -0
- package/skills/shader-dev/reference/volumetric-rendering.md +608 -0
- package/skills/shader-dev/reference/voronoi-cellular-noise.md +486 -0
- package/skills/shader-dev/reference/voxel-rendering.md +701 -0
- package/skills/shader-dev/reference/water-ocean.md +445 -0
- package/skills/shader-dev/reference/webgl-pitfalls.md +41 -0
- package/skills/shader-dev/techniques/ambient-occlusion.md +364 -0
- package/skills/shader-dev/techniques/analytic-ray-tracing.md +542 -0
- package/skills/shader-dev/techniques/anti-aliasing.md +124 -0
- package/skills/shader-dev/techniques/atmospheric-scattering.md +522 -0
- package/skills/shader-dev/techniques/camera-effects.md +115 -0
- package/skills/shader-dev/techniques/cellular-automata.md +531 -0
- package/skills/shader-dev/techniques/color-palette.md +380 -0
- package/skills/shader-dev/techniques/csg-boolean-operations.md +491 -0
- package/skills/shader-dev/techniques/domain-repetition.md +333 -0
- package/skills/shader-dev/techniques/domain-warping.md +414 -0
- package/skills/shader-dev/techniques/fluid-simulation.md +1175 -0
- package/skills/shader-dev/techniques/fractal-rendering.md +436 -0
- package/skills/shader-dev/techniques/lighting-model.md +527 -0
- package/skills/shader-dev/techniques/matrix-transform.md +455 -0
- package/skills/shader-dev/techniques/multipass-buffer.md +922 -0
- package/skills/shader-dev/techniques/normal-estimation.md +318 -0
- package/skills/shader-dev/techniques/particle-system.md +1203 -0
- package/skills/shader-dev/techniques/path-tracing-gi.md +623 -0
- package/skills/shader-dev/techniques/polar-uv-manipulation.md +373 -0
- package/skills/shader-dev/techniques/post-processing.md +788 -0
- package/skills/shader-dev/techniques/procedural-2d-pattern.md +346 -0
- package/skills/shader-dev/techniques/procedural-noise.md +554 -0
- package/skills/shader-dev/techniques/ray-marching.md +467 -0
- package/skills/shader-dev/techniques/sdf-2d.md +631 -0
- package/skills/shader-dev/techniques/sdf-3d.md +589 -0
- package/skills/shader-dev/techniques/sdf-tricks.md +100 -0
- package/skills/shader-dev/techniques/shadow-techniques.md +776 -0
- package/skills/shader-dev/techniques/simulation-physics.md +1542 -0
- package/skills/shader-dev/techniques/sound-synthesis.md +490 -0
- package/skills/shader-dev/techniques/terrain-rendering.md +408 -0
- package/skills/shader-dev/techniques/texture-mapping-advanced.md +121 -0
- package/skills/shader-dev/techniques/texture-sampling.md +382 -0
- package/skills/shader-dev/techniques/volumetric-rendering.md +375 -0
- package/skills/shader-dev/techniques/voronoi-cellular-noise.md +458 -0
- package/skills/shader-dev/techniques/voxel-rendering.md +985 -0
- package/skills/shader-dev/techniques/water-ocean.md +490 -0
- package/skills/shader-dev/techniques/webgl-pitfalls.md +170 -0
- package/skills/shipping-and-launch/SKILL.md +334 -0
- package/skills/silent-failure-hunting/SKILL.md +24 -0
- package/skills/source-driven-development/SKILL.md +223 -0
- package/skills/spec-driven-development/SKILL.md +235 -0
- package/skills/spec-driven-development/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/LICENSE +21 -0
- package/skills/spec-driven-development/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/NOTICE.md +9 -0
- package/skills/spec-driven-development/references/upstream/addyosmani-agent-skills/6bcfeb9dae52b11eaad23511acc165109746dbc3/spec-driven-development/SKILL.upstream.md +206 -0
- package/skills/strategy-stress-test/SKILL.md +185 -0
- package/skills/systematic-literature-review/SKILL.md +77 -0
- package/skills/test-document-generator/SKILL.md +152 -0
- package/skills/test-document-generator/references/test-document-template.md +45 -0
- package/skills/test-driven-development/SKILL.md +399 -0
- package/skills/write-skills/GLOSSARY.md +113 -0
- package/skills/write-skills/SKILL.md +133 -0
- package/skills/write-skills/references/upstream/mattpocock-skills/391a2701dd948f94f56a39f7533f8eea9a859c87/LICENSE +21 -0
- package/skills/write-skills/references/upstream/mattpocock-skills/391a2701dd948f94f56a39f7533f8eea9a859c87/NOTICE.md +9 -0
- package/skills/write-skills/references/upstream/mattpocock-skills/391a2701dd948f94f56a39f7533f8eea9a859c87/productivity/writing-great-skills/GLOSSARY.md +201 -0
- package/skills/write-skills/references/upstream/mattpocock-skills/391a2701dd948f94f56a39f7533f8eea9a859c87/productivity/writing-great-skills/SKILL.upstream.md +83 -0
- package/src/runtime/child-guard.ts +70 -0
- package/src/runtime/conflicts.ts +25 -0
- package/src/runtime/contracts.ts +9 -0
- package/src/runtime/doctor.ts +134 -0
- package/src/runtime/global-resources.ts +152 -0
- package/src/runtime/index.ts +23 -0
- package/src/runtime/lifecycle.ts +19 -0
- package/src/runtime/native-integrations.ts +44 -0
- package/src/runtime/path-boundaries.ts +69 -0
- package/src/runtime/registry.ts +213 -0
- package/src/runtime/roles.ts +64 -0
- package/src/runtime/rose-context.ts +24 -0
- package/src/runtime/subagents.ts +426 -0
- package/templates/APPEND_SYSTEM.md +12 -0
- package/upstream/aili-workflows.lock.json +3226 -0
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: deprecation-and-migration
|
|
3
|
+
description: Manages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when deciding whether to maintain or sunset existing code.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Deprecation and Migration
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Code is a liability, not an asset. Every line of code has ongoing maintenance cost — bugs to fix, dependencies to update, security patches to apply, and new engineers to onboard. Deprecation is the discipline of removing code that no longer earns its keep, and migration is the process of moving users safely from the old to the new.
|
|
11
|
+
|
|
12
|
+
Most engineering organizations are good at building things. Few are good at removing them. This skill addresses that gap.
|
|
13
|
+
|
|
14
|
+
## When to Use
|
|
15
|
+
|
|
16
|
+
- Replacing an old system, API, or library with a new one
|
|
17
|
+
- Sunsetting a feature that's no longer needed
|
|
18
|
+
- Consolidating duplicate implementations
|
|
19
|
+
- Removing dead code that nobody owns but everybody depends on
|
|
20
|
+
- Planning the lifecycle of a new system (deprecation planning starts at design time)
|
|
21
|
+
- Deciding whether to maintain a legacy system or invest in migration
|
|
22
|
+
|
|
23
|
+
## Core Principles
|
|
24
|
+
|
|
25
|
+
### Code Is a Liability
|
|
26
|
+
|
|
27
|
+
Every line of code has ongoing cost: it needs tests, documentation, security patches, dependency updates, and mental overhead for anyone working nearby. The value of code is the functionality it provides, not the code itself. When the same functionality can be provided with less code, less complexity, or better abstractions — the old code should go.
|
|
28
|
+
|
|
29
|
+
### Hyrum's Law Makes Removal Hard
|
|
30
|
+
|
|
31
|
+
With enough users, every observable behavior becomes depended on — including bugs, timing quirks, and undocumented side effects. This is why deprecation requires active migration, not just announcement. Users can't "just switch" when they depend on behaviors the replacement doesn't replicate.
|
|
32
|
+
|
|
33
|
+
### Deprecation Planning Starts at Design Time
|
|
34
|
+
|
|
35
|
+
When building something new, ask: "How would we remove this in 3 years?" Systems designed with clean interfaces, feature flags, and minimal surface area are easier to deprecate than systems that leak implementation details everywhere.
|
|
36
|
+
|
|
37
|
+
## The Deprecation Decision
|
|
38
|
+
|
|
39
|
+
Before deprecating anything, answer these questions:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
1. Does this system still provide unique value?
|
|
43
|
+
→ If yes, maintain it. If no, proceed.
|
|
44
|
+
|
|
45
|
+
2. How many users/consumers depend on it?
|
|
46
|
+
→ Quantify the migration scope.
|
|
47
|
+
|
|
48
|
+
3. Does a replacement exist?
|
|
49
|
+
→ If no, build the replacement first. Don't deprecate without an alternative.
|
|
50
|
+
|
|
51
|
+
4. What's the migration cost for each consumer?
|
|
52
|
+
→ If trivially automated, do it. If manual and high-effort, weigh against maintenance cost.
|
|
53
|
+
|
|
54
|
+
5. What's the ongoing maintenance cost of NOT deprecating?
|
|
55
|
+
→ Security risk, engineer time, opportunity cost of complexity.
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Compulsory vs Advisory Deprecation
|
|
59
|
+
|
|
60
|
+
| Type | When to Use | Mechanism |
|
|
61
|
+
|------|-------------|-----------|
|
|
62
|
+
| **Advisory** | Migration is optional, old system is stable | Warnings, documentation, nudges. Users migrate on their own timeline. |
|
|
63
|
+
| **Compulsory** | Old system has security issues, blocks progress, or maintenance cost is unsustainable | Hard deadline. Old system will be removed by date X. Provide migration tooling. |
|
|
64
|
+
|
|
65
|
+
**Default to advisory.** Use compulsory only when the maintenance cost or risk justifies forcing migration. Compulsory deprecation requires providing migration tooling, documentation, and support — you can't just announce a deadline.
|
|
66
|
+
|
|
67
|
+
🔴 **CHECKPOINT · Compulsory Deprecation:** Stop before converting advisory deprecation into a forced migration. Continue only when the accountable owner approves the reason, affected consumers, migration support plan, removal date, and rollback/extension criteria.
|
|
68
|
+
|
|
69
|
+
🔴 **CHECKPOINT · Removal Date:** Stop before publishing a hard removal date. The date must include evidence of replacement readiness, consumer impact, support channel, and who can approve an extension.
|
|
70
|
+
|
|
71
|
+
## The Migration Process
|
|
72
|
+
|
|
73
|
+
### Step 1: Build the Replacement
|
|
74
|
+
|
|
75
|
+
Don't deprecate without a working alternative. The replacement must:
|
|
76
|
+
|
|
77
|
+
- Cover all critical use cases of the old system
|
|
78
|
+
- Have documentation and migration guides
|
|
79
|
+
- Be proven in production (not just "theoretically better")
|
|
80
|
+
|
|
81
|
+
### Step 2: Announce and Document
|
|
82
|
+
|
|
83
|
+
```markdown
|
|
84
|
+
## Deprecation Notice: OldService
|
|
85
|
+
|
|
86
|
+
**Status:** Deprecated as of 2025-03-01
|
|
87
|
+
**Replacement:** NewService (see migration guide below)
|
|
88
|
+
**Removal date:** Advisory — no hard deadline yet
|
|
89
|
+
**Reason:** OldService requires manual scaling and lacks observability.
|
|
90
|
+
NewService handles both automatically.
|
|
91
|
+
|
|
92
|
+
### Migration Guide
|
|
93
|
+
1. Replace `import { client } from 'old-service'` with `import { client } from 'new-service'`
|
|
94
|
+
2. Update configuration (see examples below)
|
|
95
|
+
3. Run the migration verification script: `npx migrate-check`
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Step 3: Migrate Incrementally
|
|
99
|
+
|
|
100
|
+
Migrate consumers one at a time, not all at once. For each consumer:
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
1. Identify all touchpoints with the deprecated system
|
|
104
|
+
2. Update to use the replacement
|
|
105
|
+
3. Verify behavior matches (tests, integration checks)
|
|
106
|
+
4. Remove references to the old system
|
|
107
|
+
5. Confirm no regressions
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
**The Churn Rule:** If you own the infrastructure being deprecated, you are responsible for migrating your users — or providing backward-compatible updates that require no migration. Don't announce deprecation and leave users to figure it out.
|
|
111
|
+
|
|
112
|
+
### Step 4: Remove the Old System
|
|
113
|
+
|
|
114
|
+
Only after all consumers have migrated:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
1. Verify zero active usage (metrics, logs, dependency analysis)
|
|
118
|
+
2. 🔴 CHECKPOINT · Code Deletion: get explicit approval to delete code, tests, docs, and config
|
|
119
|
+
3. Remove associated tests, documentation, and configuration
|
|
120
|
+
4. Remove the deprecation notices
|
|
121
|
+
5. Celebrate — removing code is an achievement
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**Removal failure fallback:**
|
|
125
|
+
|
|
126
|
+
| Trigger | First action | If still unresolved |
|
|
127
|
+
|---|---|---|
|
|
128
|
+
| Active usage remains | Keep the old system running and contact the consuming owner | Extend the removal date through the Removal Date checkpoint |
|
|
129
|
+
| Replacement does not cover a critical use case | Pause compulsory migration and close the gap in the replacement | Downgrade to advisory until replacement readiness is proven |
|
|
130
|
+
| Owner approval is missing | Do not delete code | Escalate with usage evidence, migration status, and proposed new date |
|
|
131
|
+
| Deletion breaks tests or dependent builds | Restore the deleted path in the same change and identify the dependency | Re-plan consumer migration before attempting deletion again |
|
|
132
|
+
|
|
133
|
+
## Migration Patterns
|
|
134
|
+
|
|
135
|
+
### Strangler Pattern
|
|
136
|
+
|
|
137
|
+
Run old and new systems in parallel. Route traffic incrementally from old to new. When the old system handles 0% of traffic, remove it.
|
|
138
|
+
|
|
139
|
+
```
|
|
140
|
+
Phase 1: New system handles 0%, old handles 100%
|
|
141
|
+
Phase 2: New system handles 10% (canary)
|
|
142
|
+
Phase 3: New system handles 50%
|
|
143
|
+
Phase 4: New system handles 100%, old system idle
|
|
144
|
+
Phase 5: Remove old system
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Adapter Pattern
|
|
148
|
+
|
|
149
|
+
Create an adapter that translates calls from the old interface to the new implementation. Consumers keep using the old interface while you migrate the backend.
|
|
150
|
+
|
|
151
|
+
```typescript
|
|
152
|
+
// Adapter: old interface, new implementation
|
|
153
|
+
class LegacyTaskService implements OldTaskAPI {
|
|
154
|
+
constructor(private newService: NewTaskService) {}
|
|
155
|
+
|
|
156
|
+
// Old method signature, delegates to new implementation
|
|
157
|
+
getTask(id: number): OldTask {
|
|
158
|
+
const task = this.newService.findById(String(id));
|
|
159
|
+
return this.toOldFormat(task);
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Feature Flag Migration
|
|
165
|
+
|
|
166
|
+
Use feature flags to switch consumers from old to new system one at a time:
|
|
167
|
+
|
|
168
|
+
```typescript
|
|
169
|
+
function getTaskService(userId: string): TaskService {
|
|
170
|
+
if (featureFlags.isEnabled('new-task-service', { userId })) {
|
|
171
|
+
return new NewTaskService();
|
|
172
|
+
}
|
|
173
|
+
return new LegacyTaskService();
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## Zombie Code
|
|
178
|
+
|
|
179
|
+
Zombie code is code that nobody owns but everybody depends on. It's not actively maintained, has no clear owner, and accumulates security vulnerabilities and compatibility issues. Signs:
|
|
180
|
+
|
|
181
|
+
- No commits in 6+ months but active consumers exist
|
|
182
|
+
- No assigned maintainer or team
|
|
183
|
+
- Failing tests that nobody fixes
|
|
184
|
+
- Dependencies with known vulnerabilities that nobody updates
|
|
185
|
+
- Documentation that references systems that no longer exist
|
|
186
|
+
|
|
187
|
+
**Response:** Either assign an owner and maintain it properly, or deprecate it with a concrete migration plan. Zombie code cannot stay in limbo — it either gets investment or removal.
|
|
188
|
+
|
|
189
|
+
## Common Rationalizations
|
|
190
|
+
|
|
191
|
+
| Rationalization | Reality |
|
|
192
|
+
|---|---|
|
|
193
|
+
| "It still works, why remove it?" | Working code that nobody maintains accumulates security debt and complexity. Maintenance cost grows silently. |
|
|
194
|
+
| "Someone might need it later" | If it's needed later, it can be rebuilt. Keeping unused code "just in case" costs more than rebuilding. |
|
|
195
|
+
| "The migration is too expensive" | Compare migration cost to ongoing maintenance cost over 2-3 years. Migration is usually cheaper long-term. |
|
|
196
|
+
| "We'll deprecate it after we finish the new system" | Deprecation planning starts at design time. By the time the new system is done, you'll have new priorities. Plan now. |
|
|
197
|
+
| "Users will migrate on their own" | They won't. Provide tooling, documentation, and incentives — or do the migration yourself (the Churn Rule). |
|
|
198
|
+
| "We can maintain both systems indefinitely" | Two systems doing the same thing is double the maintenance, testing, documentation, and onboarding cost. |
|
|
199
|
+
|
|
200
|
+
## Red Flags
|
|
201
|
+
|
|
202
|
+
- Deprecated systems with no replacement available
|
|
203
|
+
- Deprecation announcements with no migration tooling or documentation
|
|
204
|
+
- Compulsory deprecation without explicit owner approval, support plan, and removal date
|
|
205
|
+
- "Soft" deprecation that's been advisory for years with no progress
|
|
206
|
+
- Hard removal date with no extension criteria or consumer impact evidence
|
|
207
|
+
- Zombie code with no owner and active consumers
|
|
208
|
+
- New features added to a deprecated system (invest in the replacement instead)
|
|
209
|
+
- Deprecation without measuring current usage
|
|
210
|
+
- Removing code without verifying zero active consumers
|
|
211
|
+
- Deleting code, tests, docs, or config before the Code Deletion checkpoint
|
|
212
|
+
|
|
213
|
+
## Verification
|
|
214
|
+
|
|
215
|
+
After completing a deprecation:
|
|
216
|
+
|
|
217
|
+
- [ ] Replacement is production-proven and covers all critical use cases
|
|
218
|
+
- [ ] Migration guide exists with concrete steps and examples
|
|
219
|
+
- [ ] All active consumers have been migrated (verified by metrics/logs)
|
|
220
|
+
- [ ] Old code, tests, documentation, and configuration are fully removed
|
|
221
|
+
- [ ] No references to the deprecated system remain in the codebase
|
|
222
|
+
- [ ] Deprecation notices are removed (they served their purpose)
|
|
@@ -0,0 +1,330 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: documentation-and-adrs
|
|
3
|
+
description: Create or update source-grounded documentation when the user explicitly asks for docs/ADR/onboarding material, a public contract change requires docs, or an accepted hard-to-reverse decision meets the ADR gate; do not trigger for every feature, architecture discussion, implementation, review, or SHIP request.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation and ADRs
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Document decisions, not just code. The most valuable documentation captures the *why* — the context, constraints, and trade-offs that led to a decision. Code shows *what* was built; documentation explains *why it was built this way* and *what alternatives were considered*. This context is essential for future humans and agents working in the codebase.
|
|
11
|
+
|
|
12
|
+
When documenting code or architecture, synthesize the system behavior from source evidence instead of listing files. A good document explains entry points, responsibilities, flows, invariants, and boundaries, with paths or symbols as evidence anchors.
|
|
13
|
+
|
|
14
|
+
## When to Use
|
|
15
|
+
|
|
16
|
+
- The user explicitly requests documentation, an ADR, architecture notes, API docs, or onboarding material.
|
|
17
|
+
- An accepted public API/config/workflow change requires its existing documentation to stay accurate.
|
|
18
|
+
- A settled decision is hard to reverse, surprising without context, and has a real trade-off.
|
|
19
|
+
|
|
20
|
+
**When NOT to use:** Ordinary implementation, an unresolved architecture choice, SHIP alone, obvious code, comments that restate code, or throwaway prototypes.
|
|
21
|
+
|
|
22
|
+
ROSE/`aili-delivery-flow` owns lifecycle state, material decisions, artifact placement, approvals, and verification. This skill performs one bounded documentation/ADR loop and returns `complete`, `need-user`, `need-evidence`, `material-delta`, `blocked`, or `Unverified`. It does not invoke requirements, planning, source research, review, release, or another process skill. Canonical exact-operation and claim-matched verification rules win.
|
|
23
|
+
|
|
24
|
+
## Source-Grounded Documentation Reports
|
|
25
|
+
|
|
26
|
+
Use this pattern for code documentation, architecture notes, or onboarding docs:
|
|
27
|
+
|
|
28
|
+
1. Define the reader and the decision/action the document should support.
|
|
29
|
+
2. Inspect authoritative sources first: code, tests, schemas, configs, ADRs, release notes, and existing docs.
|
|
30
|
+
3. Summarize responsibilities and flows in your own words; cite paths, symbols, commands, or docs for each non-obvious claim.
|
|
31
|
+
4. Mark stale/conflicting docs explicitly and avoid resolving product or architecture questions by writing around them.
|
|
32
|
+
5. Prefer diagrams/tables only when they clarify ownership, data flow, lifecycle, or constraints.
|
|
33
|
+
6. Include verification or freshness notes: command run, files inspected, date/version, and remaining `Unverified` gaps.
|
|
34
|
+
|
|
35
|
+
## Architecture Decision Records (ADRs)
|
|
36
|
+
|
|
37
|
+
ADRs capture the reasoning behind significant technical decisions. They're the highest-value documentation you can write.
|
|
38
|
+
|
|
39
|
+
### When to Write an ADR
|
|
40
|
+
|
|
41
|
+
- Choosing a framework, library, or major dependency
|
|
42
|
+
- Designing a data model or database schema
|
|
43
|
+
- Selecting an authentication strategy
|
|
44
|
+
- Deciding on an API architecture (REST vs. GraphQL vs. tRPC)
|
|
45
|
+
- Choosing between build tools, hosting platforms, or infrastructure
|
|
46
|
+
- Any decision that would be expensive to reverse
|
|
47
|
+
|
|
48
|
+
Offer an ADR only when all are true:
|
|
49
|
+
1. **Hard to reverse** — changing later has meaningful cost.
|
|
50
|
+
2. **Surprising without context** — a future maintainer would ask why.
|
|
51
|
+
3. **Real trade-off** — credible alternatives existed and one was chosen for a reason.
|
|
52
|
+
|
|
53
|
+
Skip ADRs for obvious choices, temporary decisions, minor implementation details, or choices with no real alternatives.
|
|
54
|
+
|
|
55
|
+
### 🔴 CHECKPOINT · ADR Decision Gate
|
|
56
|
+
|
|
57
|
+
🛑 STOP before writing an ADR as accepted when the decision changes architecture, data model, authentication, infrastructure, public API, or a hard-to-reverse dependency. Confirm the decision owner, accepted option, rejected alternatives, and reversal cost first.
|
|
58
|
+
|
|
59
|
+
If those facts are missing, write a proposed ADR or an interview packet instead of inventing rationale.
|
|
60
|
+
|
|
61
|
+
### ADR Template
|
|
62
|
+
|
|
63
|
+
Store ADRs in `docs/decisions/` with sequential numbering:
|
|
64
|
+
|
|
65
|
+
```markdown
|
|
66
|
+
# ADR-001: Use PostgreSQL for primary database
|
|
67
|
+
|
|
68
|
+
## Status
|
|
69
|
+
Accepted | Superseded by ADR-XXX | Deprecated
|
|
70
|
+
|
|
71
|
+
## Date
|
|
72
|
+
2025-01-15
|
|
73
|
+
|
|
74
|
+
## Context
|
|
75
|
+
We need a primary database for the task management application. Key requirements:
|
|
76
|
+
- Relational data model (users, tasks, teams with relationships)
|
|
77
|
+
- ACID transactions for task state changes
|
|
78
|
+
- Support for full-text search on task content
|
|
79
|
+
- Managed hosting available (for small team, limited ops capacity)
|
|
80
|
+
|
|
81
|
+
## Decision
|
|
82
|
+
Use PostgreSQL with Prisma ORM.
|
|
83
|
+
|
|
84
|
+
## Alternatives Considered
|
|
85
|
+
|
|
86
|
+
### MongoDB
|
|
87
|
+
- Pros: Flexible schema, easy to start with
|
|
88
|
+
- Cons: Our data is inherently relational; would need to manage relationships manually
|
|
89
|
+
- Rejected: Relational data in a document store leads to complex joins or data duplication
|
|
90
|
+
|
|
91
|
+
### SQLite
|
|
92
|
+
- Pros: Zero configuration, embedded, fast for reads
|
|
93
|
+
- Cons: Limited concurrent write support, no managed hosting for production
|
|
94
|
+
- Rejected: Not suitable for multi-user web application in production
|
|
95
|
+
|
|
96
|
+
### MySQL
|
|
97
|
+
- Pros: Mature, widely supported
|
|
98
|
+
- Cons: PostgreSQL has better JSON support, full-text search, and ecosystem tooling
|
|
99
|
+
- Rejected: PostgreSQL is the better fit for our feature requirements
|
|
100
|
+
|
|
101
|
+
## Consequences
|
|
102
|
+
- Prisma provides type-safe database access and migration management
|
|
103
|
+
- We can use PostgreSQL's full-text search instead of adding Elasticsearch
|
|
104
|
+
- Team needs PostgreSQL knowledge (standard skill, low risk)
|
|
105
|
+
- Hosting on managed service (Supabase, Neon, or RDS)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### ADR Lifecycle
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED)
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
- **Don't delete old ADRs.** They capture historical context.
|
|
115
|
+
- When a decision changes, write a new ADR that references and supersedes the old one.
|
|
116
|
+
|
|
117
|
+
## Inline Documentation
|
|
118
|
+
|
|
119
|
+
### When to Comment
|
|
120
|
+
|
|
121
|
+
Comment the *why*, not the *what*:
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
// BAD: Restates the code
|
|
125
|
+
// Increment counter by 1
|
|
126
|
+
counter += 1;
|
|
127
|
+
|
|
128
|
+
// GOOD: Explains non-obvious intent
|
|
129
|
+
// Rate limit uses a sliding window — reset counter at window boundary,
|
|
130
|
+
// not on a fixed schedule, to prevent burst attacks at window edges
|
|
131
|
+
if (now - windowStart > WINDOW_SIZE_MS) {
|
|
132
|
+
counter = 0;
|
|
133
|
+
windowStart = now;
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### When NOT to Comment
|
|
138
|
+
|
|
139
|
+
```typescript
|
|
140
|
+
// Don't comment self-explanatory code
|
|
141
|
+
function calculateTotal(items: CartItem[]): number {
|
|
142
|
+
return items.reduce((sum, item) => sum + item.price * item.quantity, 0);
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
// Don't leave TODO comments for things you should just do now
|
|
146
|
+
// TODO: add error handling ← Just add it
|
|
147
|
+
|
|
148
|
+
// Don't leave commented-out code
|
|
149
|
+
// const oldImplementation = () => { ... } ← Delete it, git has history
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Document Known Gotchas
|
|
153
|
+
|
|
154
|
+
```typescript
|
|
155
|
+
/**
|
|
156
|
+
* IMPORTANT: This function must be called before the first render.
|
|
157
|
+
* If called after hydration, it causes a flash of unstyled content
|
|
158
|
+
* because the theme context isn't available during SSR.
|
|
159
|
+
*
|
|
160
|
+
* See ADR-003 for the full design rationale.
|
|
161
|
+
*/
|
|
162
|
+
export function initializeTheme(theme: Theme): void {
|
|
163
|
+
// ...
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
## API Documentation
|
|
168
|
+
|
|
169
|
+
For public APIs (REST, GraphQL, library interfaces):
|
|
170
|
+
|
|
171
|
+
### 🔴 CHECKPOINT · Public API Documentation Gate
|
|
172
|
+
|
|
173
|
+
🛑 STOP before publishing API docs when the docs would define or imply new public behavior, compatibility promises, auth requirements, error codes, rate limits, or versioning policy that the implementation or owner has not confirmed.
|
|
174
|
+
|
|
175
|
+
Document the implemented contract exactly. If code, tests, OpenAPI schemas, and existing docs disagree, resolve the conflict before updating user-facing docs.
|
|
176
|
+
|
|
177
|
+
### Inline with Types (Preferred for TypeScript)
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
/**
|
|
181
|
+
* Creates a new task.
|
|
182
|
+
*
|
|
183
|
+
* @param input - Task creation data (title required, description optional)
|
|
184
|
+
* @returns The created task with server-generated ID and timestamps
|
|
185
|
+
* @throws {ValidationError} If title is empty or exceeds 200 characters
|
|
186
|
+
* @throws {AuthenticationError} If the user is not authenticated
|
|
187
|
+
*
|
|
188
|
+
* @example
|
|
189
|
+
* const task = await createTask({ title: 'Buy groceries' });
|
|
190
|
+
* console.log(task.id); // "task_abc123"
|
|
191
|
+
*/
|
|
192
|
+
export async function createTask(input: CreateTaskInput): Promise<Task> {
|
|
193
|
+
// ...
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### OpenAPI / Swagger for REST APIs
|
|
198
|
+
|
|
199
|
+
```yaml
|
|
200
|
+
paths:
|
|
201
|
+
/api/tasks:
|
|
202
|
+
post:
|
|
203
|
+
summary: Create a task
|
|
204
|
+
requestBody:
|
|
205
|
+
required: true
|
|
206
|
+
content:
|
|
207
|
+
application/json:
|
|
208
|
+
schema:
|
|
209
|
+
$ref: '#/components/schemas/CreateTaskInput'
|
|
210
|
+
responses:
|
|
211
|
+
'201':
|
|
212
|
+
description: Task created
|
|
213
|
+
content:
|
|
214
|
+
application/json:
|
|
215
|
+
schema:
|
|
216
|
+
$ref: '#/components/schemas/Task'
|
|
217
|
+
'422':
|
|
218
|
+
description: Validation error
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
## README Structure
|
|
222
|
+
|
|
223
|
+
Every project should have a README that covers:
|
|
224
|
+
|
|
225
|
+
```markdown
|
|
226
|
+
# Project Name
|
|
227
|
+
|
|
228
|
+
One-paragraph description of what this project does.
|
|
229
|
+
|
|
230
|
+
## Quick Start
|
|
231
|
+
1. Clone the repo
|
|
232
|
+
2. Install dependencies: `npm install`
|
|
233
|
+
3. Set up environment: `cp .env.example .env`
|
|
234
|
+
4. Run the dev server: `npm run dev`
|
|
235
|
+
|
|
236
|
+
## Commands
|
|
237
|
+
| Command | Description |
|
|
238
|
+
|---------|-------------|
|
|
239
|
+
| `npm run dev` | Start development server |
|
|
240
|
+
| `npm test` | Run tests |
|
|
241
|
+
| `npm run build` | Production build |
|
|
242
|
+
| `npm run lint` | Run linter |
|
|
243
|
+
|
|
244
|
+
## Architecture
|
|
245
|
+
Brief overview of the project structure and key design decisions.
|
|
246
|
+
Link to ADRs for details.
|
|
247
|
+
|
|
248
|
+
## Contributing
|
|
249
|
+
How to contribute, coding standards, PR process.
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
## Domain Glossary and CONTEXT.md
|
|
253
|
+
|
|
254
|
+
Use `CONTEXT.md` for shared domain language:
|
|
255
|
+
- canonical terms
|
|
256
|
+
- meanings understood by domain experts
|
|
257
|
+
- boundaries between similar concepts
|
|
258
|
+
- terms that reduce repeated explanation
|
|
259
|
+
|
|
260
|
+
Do not put implementation details in `CONTEXT.md` unless they are part of the domain language.
|
|
261
|
+
|
|
262
|
+
When terms conflict between user language, docs, and code, surface the mismatch before writing new docs. Prefer one canonical term and record aliases only when they help readers map old language to current language.
|
|
263
|
+
|
|
264
|
+
## Documentation Conflict Fallbacks
|
|
265
|
+
|
|
266
|
+
| Trigger | First response | If still unresolved |
|
|
267
|
+
|---|---|---|
|
|
268
|
+
| Existing docs conflict with code or tests | Treat code/tests as evidence and label docs as stale | Ask the owner which source is authoritative before editing |
|
|
269
|
+
| Two docs make incompatible claims | Identify both paths and the exact conflicting statements | Update only after the canonical source is confirmed |
|
|
270
|
+
| Public API behavior is unclear | Inspect implementation, schemas, tests, and release notes | Stop; do not create compatibility promises from inference |
|
|
271
|
+
| ADR rationale is missing | Record known context and alternatives as `Proposed` or `Draft` | Ask decision makers for the missing rationale |
|
|
272
|
+
| A doc update would require product or architecture decisions | Separate the decision from the documentation task | Do not decide by writing docs |
|
|
273
|
+
| The requested doc would expose secrets or internal-only data | Remove sensitive content and document safe operational guidance | Escalate instead of publishing the unsafe detail |
|
|
274
|
+
|
|
275
|
+
## Changelog Maintenance
|
|
276
|
+
|
|
277
|
+
For shipped features:
|
|
278
|
+
|
|
279
|
+
```markdown
|
|
280
|
+
# Changelog
|
|
281
|
+
|
|
282
|
+
## [1.2.0] - 2025-01-20
|
|
283
|
+
### Added
|
|
284
|
+
- Task sharing: users can share tasks with team members (#123)
|
|
285
|
+
- Email notifications for task assignments (#124)
|
|
286
|
+
|
|
287
|
+
### Fixed
|
|
288
|
+
- Duplicate tasks appearing when rapidly clicking create button (#125)
|
|
289
|
+
|
|
290
|
+
### Changed
|
|
291
|
+
- Task list now loads 50 items per page (was 20) for better UX (#126)
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
## Documentation for Agents
|
|
295
|
+
|
|
296
|
+
Special consideration for AI agent context:
|
|
297
|
+
|
|
298
|
+
- **CLAUDE.md / rules files** — Document project conventions so agents follow them
|
|
299
|
+
- **Spec files** — Keep specs updated so agents build the right thing
|
|
300
|
+
- **ADRs** — Help agents understand why past decisions were made (prevents re-deciding)
|
|
301
|
+
- **Inline gotchas** — Prevent agents from falling into known traps
|
|
302
|
+
|
|
303
|
+
## Common Rationalizations
|
|
304
|
+
|
|
305
|
+
| Rationalization | Reality |
|
|
306
|
+
|---|---|
|
|
307
|
+
| "The code is self-documenting" | Code shows what. It doesn't show why, what alternatives were rejected, or what constraints apply. |
|
|
308
|
+
| "We'll write docs when the API stabilizes" | APIs stabilize faster when you document them. The doc is the first test of the design. |
|
|
309
|
+
| "Nobody reads docs" | Agents do. Future engineers do. Your 3-months-later self does. |
|
|
310
|
+
| "ADRs are overhead" | A 10-minute ADR prevents a 2-hour debate about the same decision six months later. |
|
|
311
|
+
| "Comments get outdated" | Comments on *why* are stable. Comments on *what* get outdated — that's why you only write the former. |
|
|
312
|
+
|
|
313
|
+
## Red Flags
|
|
314
|
+
|
|
315
|
+
- Architectural decisions with no written rationale
|
|
316
|
+
- Public APIs with no documentation or types
|
|
317
|
+
- README that doesn't explain how to run the project
|
|
318
|
+
- Commented-out code instead of deletion
|
|
319
|
+
- TODO comments that have been there for weeks
|
|
320
|
+
- No ADRs in a project with significant architectural choices
|
|
321
|
+
- Documentation that restates the code instead of explaining intent
|
|
322
|
+
|
|
323
|
+
## Verification
|
|
324
|
+
|
|
325
|
+
For the selected documentation artifact:
|
|
326
|
+
|
|
327
|
+
- [ ] Claims are anchored to current source/contract evidence
|
|
328
|
+
- [ ] The requested audience, decision, and affected behavior are covered
|
|
329
|
+
- [ ] Conflicts and stale or `Unverified` content remain explicit
|
|
330
|
+
- [ ] The canonical owner selects the smallest freshness/structure check for this artifact
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: e2e-artifact-handling
|
|
3
|
+
description: E2E artifact handling routing. Use when traces, videos, screenshots, reports, or failure bundles need controlled repository-local placement; do not use for simple unit tests or production-mutating E2E flows.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# E2E Artifact Handling
|
|
7
|
+
|
|
8
|
+
Use this skill to define one bounded E2E evidence-collection/packaging need. ROSE may assign it to one fresh `e2e-artifact-runner` context after the delegation gate; this skill does not dispatch or invoke another process skill.
|
|
9
|
+
|
|
10
|
+
## Trigger
|
|
11
|
+
|
|
12
|
+
- E2E command needs trace/video/screenshot/report/failure-bundle evidence.
|
|
13
|
+
- A failing browser flow needs artifacts for ROSE review.
|
|
14
|
+
- User asks to preserve test artifacts from an E2E run.
|
|
15
|
+
|
|
16
|
+
## Required Safety Gate
|
|
17
|
+
|
|
18
|
+
- Use localhost, fixtures, or explicitly approved non-production/read-only targets.
|
|
19
|
+
- Require repository-local artifact placement before writing user-visible screenshots, traces, videos, reports, or bundles.
|
|
20
|
+
- Do not create new `tests/e2e/`, report, trace, screenshot, or golden directories without placement approval.
|
|
21
|
+
- Redact or avoid artifacts containing secrets, cookies, tokens, credentials, or private user data.
|
|
22
|
+
|
|
23
|
+
## Near Misses
|
|
24
|
+
|
|
25
|
+
- Browser QA without durable artifacts, test design/unit/integration verification, or coverage review are different primary intents; return the exact mismatch to ROSE.
|
|
26
|
+
|
|
27
|
+
## Required Routing
|
|
28
|
+
|
|
29
|
+
- Canonical owner: ROSE/`aili-delivery-flow`; direct artifact handling is preferred when no specialist context is needed.
|
|
30
|
+
- Optional agent: one fresh, terminal `e2e-artifact-runner` assignment after a new benefit decision; no resume, automatic retry, or final-verdict ownership.
|