feat(brief): require crewmates to read project instructions first - #1906
Open
jericho1050 wants to merge 1 commit into
Open
feat(brief): require crewmates to read project instructions first#1906jericho1050 wants to merge 1 commit into
jericho1050 wants to merge 1 commit into
Conversation
Every existing AGENTS.md/CLAUDE.md mention in the scaffold is about writing project memory at the end of a task; nothing told a worker to read the project's own instructions at the start. Shipped work has violated documented conventions (banned commands, logging and redaction rules) because the worker never opened them. Add the same short imperative block to both the ship and scout setup sections, before the first edit and before the branch step, including the clause that no task is too small to read them. Conflicts route to the status file for a ship task and to the report for a scout, matching each variant's existing reporting channel.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
bin/fm-brief.shmentionsAGENTS.md/CLAUDE.mdeleven times, and every one of them is about writing project memory at the end of a task.Nothing in the scaffold tells a worker to read the project's own instructions before starting.
That gap has already cost review cycles: shipped code violated documented project conventions because the worker never opened the project's
CLAUDE.md.Those files carry rules no diff teaches - banned commands, required tooling, logging and redaction rules that exist to keep credentials and PII out of logs.
Until now the instruction only reached a worker when firstmate remembered to type it into a brief by hand.
Change
The same short imperative block is added to both setup sections, so it is part of the scaffold contract rather than per-brief discipline:
Both keep the clause that no task is too small to read them, which is the point of the change: the failure mode is a worker deciding a one-line fix does not warrant it.
The existing "# Project memory" section is untouched - it is about writing project memory and is correct as it stands.
Verification
bash -n bin/fm-brief.shpasses.tests/fm-brief.test.shpasses in full (all cases ok).bin/fm-lint.shreports "ShellCheck not found; install ShellCheck 0.11.0 for CI parity" and exits without linting. That check is unverified locally and is left to CI; the change is prose inside an existing heredoc and adds no shell syntax.Scope note
The task was scoped to
bin/fm-brief.shonly, so no test was added totests/fm-brief.test.shasserting the new block.Worth a follow-up if this instruction should be regression-pinned like the project-memory wording already is.