Skip to content

.github/instructions/logic.md points its action example at packages/crm/src/ — a layout hotcrm does not have, and no gate covers that directory #1233

Description

@claude

Found while correcting the action-file suffix across live prose for #856. Filed rather than fixed: it is a different defect class from that card (a stale directory layout, not a suffix spelling), and folding it in would have meant an unreviewable rider on a governed-surface PR.

What is wrong

.github/instructions/logic.md:71 — the worked example in the "Action Implementation Standard" section — names a file in a repository layout that does not exist:

// packages/crm/src/ai_briefing.actions.ts

There is no packages/ directory in hotcrm. Application source lives at src/<kind>/, and action files specifically at src/actions/<entity>.actions.ts.

(The suffix on that line is plural because #856's PR corrected it; the path is untouched and is what this issue is about.)

Why it matters

.github/instructions/*.md are per-role agent instruction files — logic.md opens with "You are the Backend Engineer for HotCRM". An agent reading this example for where to put a new action gets a path from the retired multi-package layout, which docs/archive/README.md explicitly describes as a thing the archive preserves and current docs should not.

Observation-level: the surrounding prose and the repo tree both point at src/actions/, so a reader has two other signals. Severity is for triage — I am not grading it.

Same class, already ruled on

This is the class a previous PR closed for maintainer docs — .changeset/docs-retired-agent-cube-directories.md records removing src/agents/ and src/cubes/ references after those directories were dropped, and added a docs-drift repo-tree guard so it could not recur.

That guard does not cover this file. TREE_DOCS in test/docs-drift.test.ts lists README.md, AGENTS.md, docs/README.md, docs/STATUS.md, docs/ARCHITECTURE.md, docs/MAINTENANCE.md, docs/DEPLOYMENT.md, docs/developers/code_examples.md, docs/developers/api_reference.md — and nothing under .github/instructions/. I confirmed no gate, test or script in the repo references that directory at all:

grep -rn "\.github/instructions\|instructions/" test/ scripts/ package.json   # 0 hits

Two separate questions for whoever picks this up, and the second is the more valuable one:

  1. Correct the example path to hotcrm's real layout.
  2. Decide whether .github/instructions/** should join the docs-drift TREE_DOCS list. Six agent-instruction files currently sit outside every gate in the repo — that is why this drifted unnoticed, and why it will drift again. Note the existing guard matches src/<dir>/ forms, so catching packages/crm/src/ would need the pattern widened, not just the path list.

Duplicate check

repo:objectstack-ai/hotcrm is:issue is:open .github/instructions (0 hits), … instructions packages/crm layout (0 hits), … ai_briefing OR "multi-package" OR "retired layout" (4 hits, all unrelated: #1218, #970, #1215, #1209). If a parallel agent filed the same thing this hour, please race-close.

Refs #856


Generated by Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions