@event4u/agent-config 1.14.0 → 1.16.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/.agent-src/commands/agent-handoff.md +1 -1
- package/.agent-src/commands/bug-fix.md +3 -3
- package/.agent-src/commands/bug-investigate.md +2 -2
- package/.agent-src/commands/chat-history-checkpoint.md +3 -3
- package/.agent-src/commands/chat-history-clear.md +2 -2
- package/.agent-src/commands/chat-history-resume.md +2 -2
- package/.agent-src/commands/chat-history.md +3 -3
- package/.agent-src/commands/check-current-md.md +44 -33
- package/.agent-src/commands/commit-in-chunks.md +43 -23
- package/.agent-src/commands/compress.md +34 -2
- package/.agent-src/commands/council-design.md +96 -0
- package/.agent-src/commands/council-optimize.md +115 -0
- package/.agent-src/commands/council-pr.md +123 -0
- package/.agent-src/commands/council.md +219 -0
- package/.agent-src/commands/create-pr.md +23 -0
- package/.agent-src/commands/do-and-judge.md +3 -3
- package/.agent-src/commands/do-in-steps.md +4 -4
- package/.agent-src/commands/e2e-heal.md +1 -1
- package/.agent-src/commands/e2e-plan.md +1 -1
- package/.agent-src/commands/feature-dev.md +8 -0
- package/.agent-src/commands/feature-explore.md +6 -1
- package/.agent-src/commands/feature-plan.md +33 -2
- package/.agent-src/commands/feature-refactor.md +5 -0
- package/.agent-src/commands/feature-roadmap.md +8 -3
- package/.agent-src/commands/feature.md +58 -0
- package/.agent-src/commands/fix-ci.md +5 -0
- package/.agent-src/commands/fix-portability.md +7 -2
- package/.agent-src/commands/fix-pr-bot-comments.md +5 -0
- package/.agent-src/commands/fix-pr-comments.md +5 -0
- package/.agent-src/commands/fix-pr-developer-comments.md +5 -0
- package/.agent-src/commands/fix-references.md +5 -0
- package/.agent-src/commands/fix-seeder.md +5 -0
- package/.agent-src/commands/fix.md +60 -0
- package/.agent-src/commands/jira-ticket.md +1 -1
- package/.agent-src/commands/judge.md +1 -1
- package/.agent-src/commands/memory-add.md +3 -3
- package/.agent-src/commands/memory-full.md +2 -2
- package/.agent-src/commands/memory-promote.md +2 -2
- package/.agent-src/commands/mode.md +5 -5
- package/.agent-src/commands/onboard.md +17 -8
- package/.agent-src/commands/optimize-agents.md +6 -1
- package/.agent-src/commands/optimize-augmentignore.md +14 -0
- package/.agent-src/commands/optimize-rtk-filters.md +5 -0
- package/.agent-src/commands/optimize-skills.md +6 -1
- package/.agent-src/commands/optimize.md +54 -0
- package/.agent-src/commands/propose-memory.md +2 -2
- package/.agent-src/commands/refine-ticket.md +9 -7
- package/.agent-src/commands/review-changes.md +61 -9
- package/.agent-src/commands/review-routing.md +1 -1
- package/.agent-src/commands/roadmap-create.md +42 -4
- package/.agent-src/commands/roadmap-execute.md +9 -7
- package/.agent-src/commands/set-cost-profile.md +11 -3
- package/.agent-src/commands/sync-agent-settings.md +11 -2
- package/.agent-src/commands/tests-create.md +1 -1
- package/.agent-src/commands/tests-execute.md +2 -3
- package/.agent-src/commands/upstream-contribute.md +1 -1
- package/.agent-src/contexts/authority/commit-mechanics.md +57 -0
- package/.agent-src/contexts/authority/destructive-mechanics.md +66 -0
- package/.agent-src/contexts/authority/scope-mechanics.md +87 -0
- package/.agent-src/contexts/execution/autonomy-detection.md +54 -0
- package/.agent-src/contexts/execution/autonomy-examples.md +90 -0
- package/.agent-src/contexts/execution/autonomy-mechanics.md +29 -0
- package/.agent-src/contexts/execution/verification-mechanics.md +80 -0
- package/.agent-src/personas/README.md +1 -1
- package/.agent-src/rules/agent-authority.md +24 -0
- package/.agent-src/rules/architecture.md +1 -1
- package/.agent-src/rules/artifact-drafting-protocol.md +1 -1
- package/.agent-src/rules/artifact-engagement-recording.md +2 -2
- package/.agent-src/rules/ask-when-uncertain.md +1 -1
- package/.agent-src/rules/augment-portability.md +56 -37
- package/.agent-src/rules/autonomous-execution.md +78 -114
- package/.agent-src/rules/capture-learnings.md +1 -1
- package/.agent-src/rules/chat-history-cadence.md +109 -0
- package/.agent-src/rules/chat-history-ownership.md +123 -0
- package/.agent-src/rules/chat-history-visibility.md +96 -0
- package/.agent-src/rules/cli-output-handling.md +1 -1
- package/.agent-src/rules/{command-suggestion.md → command-suggestion-policy.md} +10 -9
- package/.agent-src/rules/commit-conventions.md +1 -1
- package/.agent-src/rules/commit-policy.md +43 -61
- package/.agent-src/rules/context-hygiene.md +3 -3
- package/.agent-src/rules/direct-answers.md +2 -2
- package/.agent-src/rules/docs-sync.md +1 -1
- package/.agent-src/rules/e2e-testing.md +1 -1
- package/.agent-src/rules/guidelines.md +4 -4
- package/.agent-src/rules/improve-before-implement.md +2 -2
- package/.agent-src/rules/language-and-tone.md +41 -96
- package/.agent-src/rules/minimal-safe-diff.md +3 -3
- package/.agent-src/rules/model-recommendation.md +4 -4
- package/.agent-src/rules/no-cheap-questions.md +89 -0
- package/.agent-src/rules/non-destructive-by-default.md +25 -59
- package/.agent-src/rules/onboarding-gate.md +5 -5
- package/.agent-src/rules/review-routing-awareness.md +9 -9
- package/.agent-src/rules/roadmap-progress-sync.md +132 -80
- package/.agent-src/rules/role-mode-adherence.md +3 -3
- package/.agent-src/rules/scope-control.md +65 -46
- package/.agent-src/rules/security-sensitive-stop.md +2 -2
- package/.agent-src/rules/size-enforcement.md +3 -2
- package/.agent-src/rules/think-before-action.md +5 -5
- package/.agent-src/rules/token-efficiency.md +4 -4
- package/.agent-src/rules/{ui-audit-before-build.md → ui-audit-gate.md} +3 -3
- package/.agent-src/rules/user-interaction.md +31 -7
- package/.agent-src/rules/verify-before-complete.md +12 -67
- package/.agent-src/scripts/update_roadmap_progress.py +65 -8
- package/.agent-src/skills/ai-council/SKILL.md +333 -0
- package/.agent-src/skills/api-endpoint/SKILL.md +2 -2
- package/.agent-src/skills/blade-ui/SKILL.md +30 -11
- package/.agent-src/skills/blast-radius-analyzer/SKILL.md +1 -1
- package/.agent-src/skills/bug-analyzer/SKILL.md +1 -1
- package/.agent-src/skills/command-routing/SKILL.md +1 -1
- package/.agent-src/skills/command-writing/SKILL.md +16 -5
- package/.agent-src/skills/conventional-commits-writing/SKILL.md +1 -1
- package/.agent-src/skills/copilot-agents-optimization/SKILL.md +2 -2
- package/.agent-src/skills/developer-like-execution/SKILL.md +2 -2
- package/.agent-src/skills/existing-ui-audit/SKILL.md +24 -9
- package/.agent-src/skills/fe-design/SKILL.md +20 -15
- package/.agent-src/skills/file-editor/SKILL.md +9 -0
- package/.agent-src/skills/flux/SKILL.md +1 -1
- package/.agent-src/skills/git-workflow/SKILL.md +1 -1
- package/.agent-src/skills/guideline-writing/SKILL.md +11 -11
- package/.agent-src/skills/learning-to-rule-or-skill/SKILL.md +4 -4
- package/.agent-src/skills/livewire/SKILL.md +27 -8
- package/.agent-src/skills/override-management/SKILL.md +2 -2
- package/.agent-src/skills/php-coder/SKILL.md +1 -1
- package/.agent-src/skills/playwright-testing/SKILL.md +2 -2
- package/.agent-src/skills/readme-reviewer/SKILL.md +1 -1
- package/.agent-src/skills/readme-writing/SKILL.md +1 -1
- package/.agent-src/skills/readme-writing-package/SKILL.md +1 -1
- package/.agent-src/skills/receiving-code-review/SKILL.md +1 -1
- package/.agent-src/skills/refine-ticket/SKILL.md +30 -24
- package/.agent-src/skills/review-routing/SKILL.md +2 -2
- package/.agent-src/skills/roadmap-management/SKILL.md +22 -16
- package/.agent-src/skills/rule-writing/SKILL.md +1 -1
- package/.agent-src/skills/skill-reviewer/SKILL.md +1 -1
- package/.agent-src/skills/skill-writing/SKILL.md +6 -6
- package/.agent-src/skills/subagent-orchestration/SKILL.md +1 -0
- package/.agent-src/skills/systematic-debugging/SKILL.md +1 -1
- package/.agent-src/skills/upstream-contribute/SKILL.md +3 -3
- package/.agent-src/skills/validate-feature-fit/SKILL.md +2 -2
- package/.agent-src/skills/{verify-before-complete → verify-completion-evidence}/SKILL.md +2 -2
- package/.agent-src/templates/agent-settings.md +9 -9
- package/.agent-src/templates/contexts/auth-model.md +1 -1
- package/.agent-src/templates/roadmaps.md +9 -8
- package/.agent-src/templates/scripts/README.md +2 -2
- package/.agent-src/templates/scripts/memory_lookup.py +1 -1
- package/.agent-src/templates/scripts/telemetry/aggregator.py +16 -1
- package/.agent-src/templates/scripts/telemetry/engagement.py +59 -0
- package/.agent-src/templates/scripts/telemetry/report_renderer.py +28 -1
- package/.agent-src/templates/scripts/telemetry_record.py +14 -1
- package/.agent-src/templates/scripts/work_engine/__init__.py +2 -2
- package/.agent-src/templates/scripts/work_engine/cli.py +64 -461
- package/.agent-src/templates/scripts/work_engine/cli_args.py +116 -0
- package/.agent-src/templates/scripts/work_engine/delivery_state.py +3 -3
- package/.agent-src/templates/scripts/work_engine/directives/backend/__init__.py +1 -1
- package/.agent-src/templates/scripts/work_engine/directives/backend/implement.py +1 -1
- package/.agent-src/templates/scripts/work_engine/directives/backend/memory.py +1 -1
- package/.agent-src/templates/scripts/work_engine/directives/backend/plan.py +1 -1
- package/.agent-src/templates/scripts/work_engine/directives/backend/report.py +1 -1
- package/.agent-src/templates/scripts/work_engine/dispatcher.py +1 -1
- package/.agent-src/templates/scripts/work_engine/emitters.py +43 -0
- package/.agent-src/templates/scripts/work_engine/errors.py +19 -0
- package/.agent-src/templates/scripts/work_engine/hook_bootstrap.py +76 -0
- package/.agent-src/templates/scripts/work_engine/input_builders.py +163 -0
- package/.agent-src/templates/scripts/work_engine/migration/v0_to_v1.py +34 -2
- package/.agent-src/templates/scripts/work_engine/persona_policy.py +1 -1
- package/.agent-src/templates/scripts/work_engine/resolvers/prompt.py +1 -1
- package/.agent-src/templates/scripts/work_engine/state_io.py +202 -0
- package/.claude-plugin/marketplace.json +10 -2
- package/AGENTS.md +16 -12
- package/CHANGELOG.md +206 -9
- package/README.md +51 -52
- package/config/agent-settings.template.yml +58 -1
- package/config/gitignore-block.txt +3 -0
- package/docs/MIGRATION.md +122 -0
- package/docs/architecture.md +83 -34
- package/docs/catalog.md +331 -0
- package/docs/contracts/STABILITY.md +134 -0
- package/docs/contracts/adr-chat-history-split.md +132 -0
- package/docs/contracts/adr-command-suggestion.md +146 -0
- package/docs/contracts/adr-implement-ticket-runtime.md +122 -0
- package/docs/contracts/adr-product-ui-track.md +384 -0
- package/docs/contracts/adr-prompt-driven-execution.md +187 -0
- package/docs/contracts/agent-memory-contract.md +149 -0
- package/docs/contracts/artifact-engagement-flow.md +262 -0
- package/docs/contracts/command-clusters.md +126 -0
- package/docs/contracts/command-suggestion-flow.md +148 -0
- package/docs/contracts/implement-ticket-flow.md +628 -0
- package/docs/contracts/linear-ai-rules-inclusion.md +143 -0
- package/docs/contracts/linear-ai-three-layers.md +131 -0
- package/docs/contracts/load-context-schema.md +186 -0
- package/docs/contracts/rule-interactions.md +107 -0
- package/docs/contracts/rule-interactions.yml +238 -0
- package/docs/contracts/rule-priority-hierarchy.md +87 -0
- package/docs/contracts/ui-stack-extension.md +236 -0
- package/docs/contracts/ui-track-flow.md +338 -0
- package/docs/customization.md +14 -0
- package/docs/end-to-end-walkthroughs.md +165 -0
- package/docs/getting-started.md +27 -9
- package/docs/github-topics.md +12 -3
- package/docs/guidelines/agent-infra/language-and-tone-examples.md +79 -0
- package/{.agent-src → docs}/guidelines/docs/readme-size-and-splitting.md +26 -25
- package/docs/guidelines/php/git.md +164 -0
- package/docs/installation.md +42 -6
- package/docs/migrations/commands-1.15.0.md +112 -0
- package/docs/showcase.md +9 -4
- package/docs/skills-catalog.md +14 -8
- package/docs/ui-track-mental-model.md +121 -0
- package/llms.txt +13 -7
- package/package.json +1 -1
- package/scripts/agent-config +23 -0
- package/scripts/ai_council/__init__.py +39 -0
- package/scripts/ai_council/_default_prices.py +41 -0
- package/scripts/ai_council/_one_off_rebalancing_audit.py +149 -0
- package/scripts/ai_council/_one_off_roundtrip.py +106 -0
- package/scripts/ai_council/budget_guard.py +172 -0
- package/scripts/ai_council/bundler.py +261 -0
- package/scripts/ai_council/clients.py +381 -0
- package/scripts/ai_council/modes.py +127 -0
- package/scripts/ai_council/orchestrator.py +350 -0
- package/scripts/ai_council/pricing.py +213 -0
- package/scripts/ai_council/project_context.py +159 -0
- package/scripts/ai_council/prompts.py +232 -0
- package/scripts/ai_council/session.py +144 -0
- package/scripts/build_linear_digest.py +4 -4
- package/scripts/check_always_budget.py +126 -0
- package/scripts/check_augmentignore.py +69 -0
- package/scripts/check_command_count_messaging.py +120 -0
- package/scripts/check_portability.py +57 -0
- package/scripts/check_public_catalog_links.py +122 -0
- package/scripts/check_public_links.py +185 -0
- package/scripts/check_references.py +5 -1
- package/scripts/check_roadmap_trackable.py +111 -0
- package/scripts/command_suggester/cooldown.py +1 -1
- package/scripts/generate_index.py +266 -0
- package/scripts/install_anthropic_key.sh +5 -0
- package/scripts/install_openai_key.sh +106 -0
- package/scripts/lint_load_context.py +163 -0
- package/scripts/lint_no_new_atomic_commands.py +179 -0
- package/scripts/lint_rule_interactions.py +149 -0
- package/scripts/memory_lookup.py +1 -1
- package/scripts/release.py +297 -64
- package/scripts/schemas/command.schema.json +20 -0
- package/scripts/schemas/rule.schema.json +10 -0
- package/scripts/skill_linter.py +26 -4
- package/scripts/sync_agent_settings.py +1 -1
- package/scripts/update_counts.py +19 -4
- package/scripts/update_prices.py +124 -0
- package/.agent-src/guidelines/php/git.md +0 -96
- package/.agent-src/rules/chat-history.md +0 -200
- /package/.agent-src/rules/{slash-commands.md → slash-command-routing-policy.md} +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/agent-interaction-and-decision-quality.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/break-glass-usage.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/developer-judgment.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/engineering-memory-data-format.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/layered-settings.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/memory-access.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/naming.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/output-patterns.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/review-routing-data-format.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/role-contracts.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/role-mode-router.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/runtime-layer.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/self-improvement-pipeline.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/size-and-scope.md +0 -0
- /package/{.agent-src → docs}/guidelines/agent-infra/tool-integration.md +0 -0
- /package/{.agent-src → docs}/guidelines/e2e/playwright.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/api-design.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/artisan-commands.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/blade-ui.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/controllers.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/database.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/eloquent.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/flux.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/general.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/jobs.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/livewire.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/logging.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/naming.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/dependency-injection.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/dtos.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/events.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/factory.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/pipelines.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/policies.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/repositories.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/service-layer.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns/strategy.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/patterns.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/performance.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/resources.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/security.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/sql.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/validations.md +0 -0
- /package/{.agent-src → docs}/guidelines/php/websocket.md +0 -0
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# language-and-tone — examples and failure modes
|
|
2
|
+
|
|
3
|
+
> Reference companion to [`.agent-src/rules/language-and-tone.md`](../../.agent-src/rules/language-and-tone.md).
|
|
4
|
+
> Pulled out so the always-active rule stays under its character budget.
|
|
5
|
+
> Linked from the rule via the **Examples** section; agents do not load this file
|
|
6
|
+
> automatically, only when they want concrete demonstrations or are debugging a
|
|
7
|
+
> language-mirroring drift.
|
|
8
|
+
|
|
9
|
+
## Failure modes to watch for
|
|
10
|
+
|
|
11
|
+
- Drafting reply in English first, then "translating the intro" → English
|
|
12
|
+
phrasing with German words. Draft in target language from the first token.
|
|
13
|
+
- Copy-pasting English option labels from `.md` sources without translating.
|
|
14
|
+
- Mixing languages inside a table or bullet list because "the technical term
|
|
15
|
+
is English" — surrounding prose must still mirror. Keep proper nouns and
|
|
16
|
+
code identifiers as-is; translate everything else.
|
|
17
|
+
- Assuming English because "the codebase is English" — codebase language ≠
|
|
18
|
+
conversation language.
|
|
19
|
+
- Mirroring the **open file** the IDE reports — open files are background
|
|
20
|
+
context, not chat messages.
|
|
21
|
+
- Mirroring the **roadmap or ticket** being executed — artefacts are English
|
|
22
|
+
by `.md` rule; chat language is whatever the user wrote.
|
|
23
|
+
|
|
24
|
+
## `.md` example labels — wrong vs correct
|
|
25
|
+
|
|
26
|
+
The agent translates option labels to the user's language **at runtime**.
|
|
27
|
+
The `.md` source files are the English blueprint — they define WHAT to say,
|
|
28
|
+
not in which language.
|
|
29
|
+
|
|
30
|
+
**Wrong** (German in `.md`):
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
> 1. Interaktiv — bei jedem Kommentar nachfragen
|
|
34
|
+
> 2. Automatisch — alle selbstständig abarbeiten
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**Correct** (English in `.md`):
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
> 1. Interactive — ask before each comment
|
|
41
|
+
> 2. Automatic — handle all independently
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Same rule applies to: example prompts and questions, template placeholders,
|
|
45
|
+
ASCII art labels in formatted output blocks, table headers and content.
|
|
46
|
+
|
|
47
|
+
## Quoted user-input examples — same rule, with one labeled exception
|
|
48
|
+
|
|
49
|
+
Common drift pattern: a rule documents trigger phrases the agent should
|
|
50
|
+
recognize and writes them as quoted German examples inside English prose.
|
|
51
|
+
**Not allowed**, even when demonstrative.
|
|
52
|
+
|
|
53
|
+
**Wrong** (DE quote embedded in EN prose):
|
|
54
|
+
|
|
55
|
+
```md
|
|
56
|
+
Single-decision delegation ("für diesen Schritt entscheide du") →
|
|
57
|
+
handle that step autonomously.
|
|
58
|
+
|
|
59
|
+
A standing "arbeite selbstständig" never lifts the floor.
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
**Correct** — two ways:
|
|
63
|
+
|
|
64
|
+
1. **Translate to English.** Trigger recognition is semantic; the agent
|
|
65
|
+
matches intent across languages regardless of the example.
|
|
66
|
+
`("you decide for this step")` works as well as the German.
|
|
67
|
+
2. **Use a labeled `DE: … · EN: …` anchor list** when the multilingual
|
|
68
|
+
nature of recognition is the point:
|
|
69
|
+
|
|
70
|
+
```md
|
|
71
|
+
- DE: "arbeite selbstständig" · "frag nicht jedes Mal" · "tue es einfach"
|
|
72
|
+
- EN: "work autonomously" · "don't ask" · "just do it"
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
The labeled-anchor block is the **only** allowed location for German prose
|
|
76
|
+
in an English `.md` file. Body text, example sentences, prompt templates,
|
|
77
|
+
agent-rendered strings, and failure modes must be English. Reference
|
|
78
|
+
established phrases abstractly later (e.g. "a standing autonomy directive")
|
|
79
|
+
and link back to the anchor block.
|
|
@@ -2,11 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
-
Keep READMEs scannable as repositories grow. A README is an
|
|
6
|
-
point**, not a reference manual. Once it stops working as entry
|
|
7
|
-
split — don't scroll.
|
|
5
|
+
Keep READMEs scannable and useful as repositories grow. A README is an
|
|
6
|
+
**entry point**, not a reference manual. Once it stops working as an entry
|
|
7
|
+
point, split — don't scroll.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
This guideline is referenced by the `readme-writing`, `readme-writing-package`,
|
|
10
|
+
and `readme-reviewer` skills.
|
|
10
11
|
|
|
11
12
|
---
|
|
12
13
|
|
|
@@ -41,8 +42,8 @@ Hard triggers — split immediately:
|
|
|
41
42
|
Soft triggers — review and probably split:
|
|
42
43
|
|
|
43
44
|
- A section needs its own Table of Contents
|
|
44
|
-
-
|
|
45
|
-
- More than one code block per section explaining variations of the same
|
|
45
|
+
- A reader has to scroll past three screens to reach "how do I use it"
|
|
46
|
+
- More than one code block per section, explaining variations of the same
|
|
46
47
|
thing (indicates reference material, not onboarding)
|
|
47
48
|
|
|
48
49
|
---
|
|
@@ -64,8 +65,8 @@ README stays < 200 lines. Each `/docs/` file is a self-contained chapter.
|
|
|
64
65
|
|
|
65
66
|
### Strategy 2 — Deep-link tables for multi-platform repos
|
|
66
67
|
|
|
67
|
-
|
|
68
|
-
links beats inline blocks:
|
|
68
|
+
When supporting many platforms or tool integrations, a single table with
|
|
69
|
+
deep links beats inline blocks:
|
|
69
70
|
|
|
70
71
|
```markdown
|
|
71
72
|
| Tool | Install | Docs |
|
|
@@ -78,8 +79,8 @@ Pattern: 1 row per platform, actual how-to in the linked doc.
|
|
|
78
79
|
|
|
79
80
|
### Strategy 3 — Collapsible sections (`<details>`)
|
|
80
81
|
|
|
81
|
-
|
|
82
|
-
options, platform-specific quirks, troubleshooting trees:
|
|
82
|
+
For content that is occasionally needed but crowds the scan path — long
|
|
83
|
+
install options, platform-specific quirks, troubleshooting trees:
|
|
83
84
|
|
|
84
85
|
```markdown
|
|
85
86
|
<details>
|
|
@@ -90,8 +91,8 @@ Content here — full detail, not shown by default.
|
|
|
90
91
|
</details>
|
|
91
92
|
```
|
|
92
93
|
|
|
93
|
-
Use sparingly. Collapsed content is still in the file; it defers
|
|
94
|
-
cost
|
|
94
|
+
Use sparingly. Collapsed content is still in the file; it just defers the
|
|
95
|
+
visual cost. Not a substitute for true splitting when content is > 30 lines.
|
|
95
96
|
|
|
96
97
|
---
|
|
97
98
|
|
|
@@ -104,15 +105,15 @@ Add a ToC when:
|
|
|
104
105
|
- Reader would need to scroll to find a known section
|
|
105
106
|
|
|
106
107
|
Place the ToC **after** the one-line summary and **before** the first
|
|
107
|
-
substantive section (usually install or quickstart).
|
|
108
|
-
small READMEs — becomes visual noise.
|
|
108
|
+
substantive section (usually install or quickstart). Do not add a ToC to
|
|
109
|
+
small READMEs — it becomes visual noise.
|
|
109
110
|
|
|
110
111
|
---
|
|
111
112
|
|
|
112
113
|
## Multi-audience repos
|
|
113
114
|
|
|
114
115
|
A single README cannot serve "consumers of a package" and "contributors
|
|
115
|
-
to a package" equally. Choose one primary audience for the README,
|
|
116
|
+
to a package" equally well. Choose one primary audience for the README,
|
|
116
117
|
deep-link the other:
|
|
117
118
|
|
|
118
119
|
- **Package repo** → consumers primary; contributors go to
|
|
@@ -120,8 +121,8 @@ deep-link the other:
|
|
|
120
121
|
- **Application repo** → contributors/team primary; end users (if any)
|
|
121
122
|
go to `docs/user-guide.md`
|
|
122
123
|
|
|
123
|
-
README must declare its audience within the first screen. Readers
|
|
124
|
-
other audience must find their link within the first screen too.
|
|
124
|
+
The README must declare its audience within the first screen. Readers
|
|
125
|
+
in the other audience must find their link within the first screen too.
|
|
125
126
|
|
|
126
127
|
---
|
|
127
128
|
|
|
@@ -129,13 +130,13 @@ other audience must find their link within the first screen too.
|
|
|
129
130
|
|
|
130
131
|
- **Splitting by accident** — moving content out "because the README is long"
|
|
131
132
|
without a navigation story. Readers get lost.
|
|
132
|
-
- **Splitting and duplicating** — same content in README and
|
|
133
|
-
They drift apart. Pick one home.
|
|
134
|
-
- **Deep-link-only README** — README that is just a table of contents
|
|
135
|
-
linking out.
|
|
133
|
+
- **Splitting and duplicating** — keeping the same content in README and
|
|
134
|
+
`/docs/`. They drift apart. Pick one home.
|
|
135
|
+
- **Deep-link-only README** — a README that is just a table of contents
|
|
136
|
+
linking out. A reader arriving cold must still learn what/why/how-install
|
|
136
137
|
without clicking.
|
|
137
|
-
- **Premature splitting** — `docs/` scaffolding for a 50-line
|
|
138
|
-
|
|
138
|
+
- **Premature splitting** — creating `docs/` scaffolding for a 50-line
|
|
139
|
+
README. The overhead is not worth it; come back at 150 lines.
|
|
139
140
|
- **Hiding critical content in `<details>`** — install, first example, and
|
|
140
141
|
requirements are **never** collapsed.
|
|
141
142
|
|
|
@@ -144,10 +145,10 @@ other audience must find their link within the first screen too.
|
|
|
144
145
|
## Validation checklist
|
|
145
146
|
|
|
146
147
|
- [ ] First screen answers what / why / install
|
|
147
|
-
- [ ] Size below "overloaded" threshold, or splitting is in place
|
|
148
|
+
- [ ] Size is below the "overloaded" threshold, or splitting is in place
|
|
148
149
|
- [ ] ToC present if > 150 lines or > 6 top-level sections
|
|
149
150
|
- [ ] No duplication between README and `/docs/`
|
|
150
151
|
- [ ] `<details>` used only for secondary, bulky content
|
|
151
152
|
- [ ] Multi-platform install uses a table, not 10 sequential install blocks
|
|
152
153
|
- [ ] Each `/docs/` file is self-contained and linked from README
|
|
153
|
-
- [ ] Audience explicit; other audience has a visible deep-link
|
|
154
|
+
- [ ] Audience is explicit; the other audience has a visible deep-link
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# Git & Version Control Guidelines
|
|
2
|
+
|
|
3
|
+
> Project-specific Git conventions. Branch naming, commit messages, PR workflow.
|
|
4
|
+
|
|
5
|
+
**Related Skills:** `git-workflow`, `conventional-commits-writing`
|
|
6
|
+
**Related Rules:** `commit-conventions.md`
|
|
7
|
+
|
|
8
|
+
## Branch Naming
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
{type}/{ticket-id}/{short-description}
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
| Type | When |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `feat/` | New feature |
|
|
17
|
+
| `fix/` | Bug fix |
|
|
18
|
+
| `hotfix/` | Urgent production fix |
|
|
19
|
+
| `chore/` | Maintenance, refactoring, tooling |
|
|
20
|
+
| `docs/` | Documentation changes |
|
|
21
|
+
| `test/` | Test additions/changes |
|
|
22
|
+
|
|
23
|
+
### Examples
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
feat/DEV-1234/user-notification-preferences
|
|
27
|
+
fix/DEV-5678/null-pointer-in-import
|
|
28
|
+
chore/refactor-agent-setup
|
|
29
|
+
hotfix/DEV-999/critical-payment-bug
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Rules
|
|
33
|
+
|
|
34
|
+
- Always include the Jira ticket ID when one exists
|
|
35
|
+
- Use kebab-case for the description part
|
|
36
|
+
- Keep branch names short but descriptive
|
|
37
|
+
|
|
38
|
+
## Commit Messages
|
|
39
|
+
|
|
40
|
+
Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
|
|
41
|
+
See `commit-conventions` rule for the base format and type table.
|
|
42
|
+
|
|
43
|
+
### Type selection rules
|
|
44
|
+
|
|
45
|
+
**`feat`** — a new capability is added; user or system can do something new.
|
|
46
|
+
|
|
47
|
+
**`fix`** — existing behavior was wrong; bug, regression, or broken edge case corrected.
|
|
48
|
+
|
|
49
|
+
**`refactor`** — structure changes, readability/maintainability improves, behavior unchanged.
|
|
50
|
+
Do NOT use `refactor` if behavior changes — use `feat` or `fix` instead.
|
|
51
|
+
|
|
52
|
+
**`docs`** — only documentation changes, no runtime or behavior change.
|
|
53
|
+
|
|
54
|
+
**`test`** — only tests added/updated, no production behavior changes.
|
|
55
|
+
|
|
56
|
+
**`ci`** — GitHub Actions, pipelines, CI checks, automation workflows, release jobs.
|
|
57
|
+
|
|
58
|
+
**`chore`** — maintenance, repo housekeeping, dependency bumps, non-functional cleanup
|
|
59
|
+
that is not better classified as `build`, `ci`, or `docs`.
|
|
60
|
+
|
|
61
|
+
**`perf`** — measurable performance improvement.
|
|
62
|
+
|
|
63
|
+
**`build`** — build tooling, packaging, Docker changes.
|
|
64
|
+
|
|
65
|
+
**`style`** — formatting only, no logic change (e.g. ECS/Rector auto-fixes).
|
|
66
|
+
|
|
67
|
+
### Scope guidance
|
|
68
|
+
|
|
69
|
+
Use a scope when it adds clarity. Good scopes:
|
|
70
|
+
|
|
71
|
+
- Jira ticket ID: `DEV-1234`
|
|
72
|
+
- Module/area: `api`, `auth`, `skills`, `rules`, `ci`, `frontend`, `linter`
|
|
73
|
+
|
|
74
|
+
Do not add a scope if it adds no value. `fix(core): fix typo` → just `fix: fix typo`.
|
|
75
|
+
|
|
76
|
+
### Description rules
|
|
77
|
+
|
|
78
|
+
- Describe **intent**, not implementation detail
|
|
79
|
+
- Describe **what changed**, not every low-level step
|
|
80
|
+
- Avoid generic wording: `update stuff`, `fix issue`, `changes`
|
|
81
|
+
|
|
82
|
+
Good: `fix(routes): preserve middleware order for api endpoints`
|
|
83
|
+
Bad: `fix: fix things`
|
|
84
|
+
|
|
85
|
+
### Breaking changes
|
|
86
|
+
|
|
87
|
+
Use `!` after type/scope or `BREAKING CHANGE:` in footer:
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
feat(api)!: rename invoice status values
|
|
91
|
+
refactor(auth)!: remove legacy session flow
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Commit splitting
|
|
95
|
+
|
|
96
|
+
If a change contains multiple unrelated concerns, split into multiple commits.
|
|
97
|
+
|
|
98
|
+
Bad: `refactor: cleanup skills and fix ci and update docs`
|
|
99
|
+
|
|
100
|
+
Better:
|
|
101
|
+
```
|
|
102
|
+
refactor(skills): remove duplicate routing helpers
|
|
103
|
+
ci(lint): add skill-lint workflow
|
|
104
|
+
docs(readme): document new lint tasks
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Squash merge titles
|
|
108
|
+
|
|
109
|
+
- Use Conventional Commit format
|
|
110
|
+
- Summarize the **net effect** of the PR
|
|
111
|
+
- Do not copy vague branch names
|
|
112
|
+
- Do not include issue noise if it hurts readability
|
|
113
|
+
|
|
114
|
+
### Examples by area
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
# Features
|
|
118
|
+
feat(DEV-2133): send email to customer when product is shipped
|
|
119
|
+
|
|
120
|
+
# Bug fixes
|
|
121
|
+
fix(import): handle null values in equipment JSON
|
|
122
|
+
|
|
123
|
+
# Refactoring
|
|
124
|
+
refactor: extract user sync logic into dedicated service
|
|
125
|
+
|
|
126
|
+
# Skills / Rules / Agent config
|
|
127
|
+
refactor(skills): merge duplicate analysis skills
|
|
128
|
+
feat(rules): add analysis routing quality gate
|
|
129
|
+
fix(skills): restore concrete validation in skill reviewer
|
|
130
|
+
|
|
131
|
+
# CI / Tooling
|
|
132
|
+
ci(lint): add skill linter workflow
|
|
133
|
+
feat(linter): detect pointer-only skills
|
|
134
|
+
|
|
135
|
+
# Docs
|
|
136
|
+
docs(roadmap): add phase 3 implementation plan
|
|
137
|
+
docs(readme): clarify source-of-truth workflow
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Decision checklist
|
|
141
|
+
|
|
142
|
+
Before writing the commit message:
|
|
143
|
+
|
|
144
|
+
1. Did behavior change? → `feat` or `fix`
|
|
145
|
+
2. Was it only structure/cleanup? → `refactor`
|
|
146
|
+
3. Was it only docs, tests, or CI? → `docs`, `test`, `ci`
|
|
147
|
+
4. Is the scope useful or just noise?
|
|
148
|
+
5. Is this actually multiple commits hiding in one?
|
|
149
|
+
|
|
150
|
+
### Anti-patterns
|
|
151
|
+
|
|
152
|
+
- `update stuff` / `fix bug` / `changes` / `refactor everything`
|
|
153
|
+
- Using `chore` for meaningful behavior changes
|
|
154
|
+
- Using `refactor` for bug fixes
|
|
155
|
+
- Using one commit for multiple unrelated concerns
|
|
156
|
+
- Vague squash merge titles that don't describe the net effect
|
|
157
|
+
|
|
158
|
+
## Pull Requests
|
|
159
|
+
|
|
160
|
+
- PR title follows commit message format: `feat(DEV-1234): short description`
|
|
161
|
+
- Fill in the PR template (checklist, description, testing notes)
|
|
162
|
+
- Link the Jira ticket in the PR description
|
|
163
|
+
- Ensure all quality gates pass before requesting review
|
|
164
|
+
|
package/docs/installation.md
CHANGED
|
@@ -23,6 +23,23 @@ No Task, no Make, no build tools required for installation.
|
|
|
23
23
|
| **Project-installed** (recommended) | Teams, shared standards | Repository-wide |
|
|
24
24
|
| **Plugin-installed** | Individual users, global use | User-wide |
|
|
25
25
|
|
|
26
|
+
> **All paths on this page are still supported.** The labels
|
|
27
|
+
> (`advanced` / `experimental` / `staged`) describe how prominent the
|
|
28
|
+
> path is in our recommendation order, not its support status.
|
|
29
|
+
> Composer + npm are the default; everything else stays shipped and
|
|
30
|
+
> tested. Nothing on this page is being removed in 1.15.0 — the
|
|
31
|
+
> reorder simply marks which paths get the most maintenance attention
|
|
32
|
+
> and which we keep as fallbacks. See R9 in
|
|
33
|
+
> [`agents/roadmaps/archive/road-to-post-pr29-optimize.md`](../agents/roadmaps/archive/road-to-post-pr29-optimize.md)
|
|
34
|
+
> for the rationale.
|
|
35
|
+
|
|
36
|
+
| Label | Meaning | Examples |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| (no label) | Primary path — first-class, fully supported | Composer, npm, Augment / Claude Code / Copilot CLI plugins |
|
|
39
|
+
| `advanced` | Supported fallback — works, expects familiarity with the toolchain | Git submodule, manual clone, VS Code Git URL |
|
|
40
|
+
| `experimental` | Shipped but evolving — interface may shift between minor releases | Claude.ai Web Skills UI |
|
|
41
|
+
| `staged` | Shipped, narrow surface area — kept for users who already use the platform | Linear AI workspace guidance |
|
|
42
|
+
|
|
26
43
|
---
|
|
27
44
|
|
|
28
45
|
## Project-installed mode (recommended for teams)
|
|
@@ -210,7 +227,16 @@ These channels are **additional** to project- and plugin-installed
|
|
|
210
227
|
modes; use them when the agent loop runs on the platform's servers,
|
|
211
228
|
not on your machine.
|
|
212
229
|
|
|
213
|
-
|
|
230
|
+
> Both cloud channels remain shipped and tested. The labels reflect
|
|
231
|
+
> recommendation prominence, not support status — see the label table
|
|
232
|
+
> at the top of this page.
|
|
233
|
+
|
|
234
|
+
### Claude.ai Web (Skills UI) — `experimental`
|
|
235
|
+
|
|
236
|
+
> `experimental` — shipped, still tested, but the upload surface and
|
|
237
|
+
> bundle format may shift between minor releases as Claude.ai's Skills
|
|
238
|
+
> UI evolves. Pin to a release tag if you depend on a specific bundle
|
|
239
|
+
> shape.
|
|
214
240
|
|
|
215
241
|
Claude.ai Web supports Skills via manual ZIP upload through the Skills
|
|
216
242
|
UI. The package builds one ZIP per cloud-eligible skill.
|
|
@@ -238,7 +264,12 @@ UI. The package builds one ZIP per cloud-eligible skill.
|
|
|
238
264
|
3. **Verify** — open a fresh Claude.ai conversation and confirm the
|
|
239
265
|
skill appears in the Skills picker.
|
|
240
266
|
|
|
241
|
-
### Linear AI (Codegen, Charlie, …)
|
|
267
|
+
### Linear AI (Codegen, Charlie, …) — `staged`
|
|
268
|
+
|
|
269
|
+
> `staged` — shipped, narrow surface area, kept primarily for users
|
|
270
|
+
> already operating inside Linear. Iteration cadence is slower than
|
|
271
|
+
> the project- and plugin-installed paths; major changes land first
|
|
272
|
+
> on Composer + npm and propagate to the Linear digest in a follow-up.
|
|
242
273
|
|
|
243
274
|
Linear AI agents read free-form guidance from Linear's workspace
|
|
244
275
|
settings; there is no plugin or upload mechanism. The package ships
|
|
@@ -264,16 +295,21 @@ the matching Linear field.
|
|
|
264
295
|
- Leave `personal.md` empty unless you have personal overrides
|
|
265
296
|
|
|
266
297
|
3. **Per-layer rationale** — see
|
|
267
|
-
[`
|
|
298
|
+
[`docs/contracts/linear-ai-three-layers.md`](contracts/linear-ai-three-layers.md)
|
|
268
299
|
for the split rationale and
|
|
269
|
-
[`
|
|
300
|
+
[`docs/contracts/linear-ai-rules-inclusion.md`](contracts/linear-ai-rules-inclusion.md)
|
|
270
301
|
for which rules go where.
|
|
271
302
|
|
|
272
303
|
---
|
|
273
304
|
|
|
274
|
-
## Alternative install methods
|
|
305
|
+
## Alternative install methods — `advanced`
|
|
275
306
|
|
|
276
|
-
|
|
307
|
+
> `advanced` — supported fallbacks for users comfortable driving the
|
|
308
|
+
> orchestrator directly. They share the same `scripts/install` entry
|
|
309
|
+
> point as Composer and npm; the only difference is how the package
|
|
310
|
+
> source ends up on disk. Pick these when you cannot use Composer or
|
|
311
|
+
> npm (e.g. a polyglot repo without either, or a CI runner that
|
|
312
|
+
> already vendors the package via submodule).
|
|
277
313
|
|
|
278
314
|
### Git Submodule
|
|
279
315
|
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# Command migration — 1.15.0
|
|
2
|
+
|
|
3
|
+
> **Audience:** consumers of `event4u/agent-config` upgrading from
|
|
4
|
+
> `1.14.x` to `1.15.0`.
|
|
5
|
+
> **Authoritative spec:** [`docs/contracts/command-clusters.md`](../contracts/command-clusters.md).
|
|
6
|
+
|
|
7
|
+
`1.15.0` collapses 15 atomic commands into 3 verb clusters
|
|
8
|
+
(`fix`, `optimize`, `feature`) to reduce command-palette
|
|
9
|
+
fragmentation. **Old commands keep working through the entire
|
|
10
|
+
1.15.x cycle**; they emit a one-line deprecation warning on
|
|
11
|
+
invocation and are removed in `1.16.0`.
|
|
12
|
+
|
|
13
|
+
## Summary table
|
|
14
|
+
|
|
15
|
+
| Old command | New invocation | Removed in |
|
|
16
|
+
|---|---|---|
|
|
17
|
+
| `/fix-ci` | `/fix ci` | 1.16.0 |
|
|
18
|
+
| `/fix-pr-comments` | `/fix pr` | 1.16.0 |
|
|
19
|
+
| `/fix-pr-bot-comments` | `/fix pr-bots` | 1.16.0 |
|
|
20
|
+
| `/fix-pr-developer-comments` | `/fix pr-developers` | 1.16.0 |
|
|
21
|
+
| `/fix-portability` | `/fix portability` | 1.16.0 |
|
|
22
|
+
| `/fix-references` | `/fix refs` | 1.16.0 |
|
|
23
|
+
| `/fix-seeder` | `/fix seeder` | 1.16.0 |
|
|
24
|
+
| `/optimize-agents` | `/optimize agents` | 1.16.0 |
|
|
25
|
+
| `/optimize-augmentignore` | `/optimize augmentignore` | 1.16.0 |
|
|
26
|
+
| `/optimize-rtk-filters` | `/optimize rtk` | 1.16.0 |
|
|
27
|
+
| `/optimize-skills` | `/optimize skills` | 1.16.0 |
|
|
28
|
+
| `/feature-explore` | `/feature explore` | 1.16.0 |
|
|
29
|
+
| `/feature-plan` | `/feature plan` | 1.16.0 |
|
|
30
|
+
| `/feature-refactor` | `/feature refactor` | 1.16.0 |
|
|
31
|
+
| `/feature-roadmap` | `/feature roadmap` | 1.16.0 |
|
|
32
|
+
|
|
33
|
+
## What changes for you
|
|
34
|
+
|
|
35
|
+
**Nothing breaks in 1.15.x.** Old slugs continue to work — the agent
|
|
36
|
+
recognises them, dispatches to the new cluster command, and prints
|
|
37
|
+
one warning line at the top of the reply:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
⚠️ /fix-ci is deprecated; use /fix ci instead.
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Your existing custom skills, rules, or agents/roadmaps that
|
|
44
|
+
reference old slugs do not need to change in 1.15.x.** Update at
|
|
45
|
+
your own pace.
|
|
46
|
+
|
|
47
|
+
## What to update before 1.16.0
|
|
48
|
+
|
|
49
|
+
Search your project for any direct references to the old slugs and
|
|
50
|
+
swap them for the new invocation:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# Find references in agents/, docs/, README, custom rules
|
|
54
|
+
rg -n '/(fix|optimize|feature)-[a-z-]+' \
|
|
55
|
+
agents/ docs/ README.md AGENTS.md .github/ 2>/dev/null
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Common spots:
|
|
59
|
+
|
|
60
|
+
- `agents/roadmaps/*.md` — roadmap steps that name commands
|
|
61
|
+
- `agents/contexts/*.md` — context docs cross-linking commands
|
|
62
|
+
- Custom skills/rules under `.augment/` overrides
|
|
63
|
+
- Internal team docs / runbooks / onboarding pages
|
|
64
|
+
|
|
65
|
+
## Why this changed
|
|
66
|
+
|
|
67
|
+
The atomic-command surface had grown to 77 commands by 1.14.0. Three
|
|
68
|
+
prefix families (`fix-*`, `optimize-*`, `feature-*`) accounted for 15
|
|
69
|
+
of those — same verb, same invocation pattern, only the noun
|
|
70
|
+
differed. Collapsing the families into clusters:
|
|
71
|
+
|
|
72
|
+
- Reduces palette noise (15 → 3 top-level entries).
|
|
73
|
+
- Makes new sub-commands additive (`/fix tests` ships without a new
|
|
74
|
+
top-level slug).
|
|
75
|
+
- Holds the line: `scripts/lint_no_new_atomic_commands.py` fails CI
|
|
76
|
+
if a new atomic command lands without a `cluster:` field declared
|
|
77
|
+
in [`docs/contracts/command-clusters.md`](../contracts/command-clusters.md).
|
|
78
|
+
|
|
79
|
+
## Phase 2 (deferred)
|
|
80
|
+
|
|
81
|
+
A second wave of collapses (`chat-history`, `agents`, `memory`,
|
|
82
|
+
`roadmap`, `module`, `tests`, `context`, `override`, `copilot-agents`,
|
|
83
|
+
`commit`, `judge`, `create-pr`) is scheduled after 1.15.0 ships and
|
|
84
|
+
the deprecation cycle for Phase 1 closes. Tracked in
|
|
85
|
+
[`agents/roadmaps/archive/road-to-governance-cleanup.md`](../../agents/roadmaps/archive/road-to-governance-cleanup.md)
|
|
86
|
+
§ F2.
|
|
87
|
+
|
|
88
|
+
## Related rule split — `chat-history` (post-1.15.0)
|
|
89
|
+
|
|
90
|
+
The monolithic `rules/chat-history.md` was split into three sibling
|
|
91
|
+
`always` rules in the post-1.15.0 optimization phase:
|
|
92
|
+
|
|
93
|
+
- [`chat-history-ownership`](../../.agent-src/rules/chat-history-ownership.md) — sole owner of file I/O + first-turn handshake.
|
|
94
|
+
- [`chat-history-cadence`](../../.agent-src/rules/chat-history-cadence.md) — when to persist (SessionStart / StepEnd / append boundaries).
|
|
95
|
+
- [`chat-history-visibility`](../../.agent-src/rules/chat-history-visibility.md) — heartbeat marker contract for user-facing reporting.
|
|
96
|
+
|
|
97
|
+
Decision record: [`docs/contracts/adr-chat-history-split.md`](../contracts/adr-chat-history-split.md).
|
|
98
|
+
Cross-references in commands and contexts now point to
|
|
99
|
+
`chat-history-ownership` as the entry point.
|
|
100
|
+
|
|
101
|
+
## Rollback
|
|
102
|
+
|
|
103
|
+
If a deprecation warning blocks tooling that screen-scrapes agent
|
|
104
|
+
output, suppress it for the 1.15.x cycle by setting
|
|
105
|
+
`commands.deprecation_warnings: false` in `.agent-settings.yml`.
|
|
106
|
+
The setting disappears in 1.16.0 along with the shims.
|
|
107
|
+
|
|
108
|
+
## See also
|
|
109
|
+
|
|
110
|
+
- [`docs/contracts/command-clusters.md`](../contracts/command-clusters.md) — locked cluster spec.
|
|
111
|
+
- [`docs/contracts/STABILITY.md`](../contracts/STABILITY.md) — public-surface stability tiers.
|
|
112
|
+
- [`agents/roadmaps/archive/road-to-post-pr29-optimize.md`](../../agents/roadmaps/archive/road-to-post-pr29-optimize.md) — P0.8 anchor for this migration.
|
package/docs/showcase.md
CHANGED
|
@@ -192,10 +192,15 @@ criteria, assumptions, confidence band) before the engine plans.
|
|
|
192
192
|
|
|
193
193
|
## More
|
|
194
194
|
|
|
195
|
-
The five examples above cover the load-bearing iron laws.
|
|
196
|
-
|
|
197
|
-
the
|
|
198
|
-
|
|
195
|
+
The five examples above cover the load-bearing iron laws. For the
|
|
196
|
+
**cycle-by-cycle traces** of the engine commands (`/implement-ticket`,
|
|
197
|
+
`/work`, the UI track, and the blocked path), see
|
|
198
|
+
[`end-to-end-walkthroughs.md`](end-to-end-walkthroughs.md) — each
|
|
199
|
+
walkthrough is anchored to a checked-in golden transcript.
|
|
200
|
+
|
|
201
|
+
The full rule set lives in [`.agent-src/rules/`](../.agent-src/rules/)
|
|
202
|
+
(browse the `description:` line in each file's frontmatter to see
|
|
203
|
+
when it auto-triggers); the full skill catalog is in
|
|
199
204
|
[`docs/skills-catalog.md`](skills-catalog.md).
|
|
200
205
|
|
|
201
206
|
**Suggesting an example?** Open a PR adding a new section here. Same
|