feat: scaffold a workspace README and a Project notes section in AGENTS file for user provided standards#68
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
redmodd
changed the title
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
prettier reads __PROJECT_NAME__ as markdown bold and had rewritten it to **PROJECT_NAME**, so copyTemplate never substituted the workspace name. Restore the token and add the template README to .prettierignore. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
redmodd
added a commit
that referenced
this pull request
Jun 4, 2026
The scaffolded root CLAUDE.md/AGENTS.md aren't immutable pointers — they carry a Project notes section for user-provided standards (#68). Updates don't overwrite them. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Summary
Gives scaffolded Tessera workspaces a place for human and author-specific context, alongside the existing framework pointer:
README.md— a human-facing repo front page (workspace name, an "edit this" placeholder, quick-start commands), distinct from the agent-facingAGENTS.md. Points atAGENTS.mdrather than duplicating the version-locked authoring guide.AGENTS.md"Project notes" — a clearly-delimited section inviting the user to add their own agent context (audience, voice/tone, brand & a11y, review/conventions), stated to take precedence over the framework guide. The "nothing to keep in sync" note is rescoped to the framework portion so it no longer discourages editing. Lands in bothAGENTS.mdandCLAUDE.md(stamped identical).Tests
tests/scaffold.test.ts: asserts theREADME.mdrenders headed by the workspace name with the quick-start and anAGENTS.mdpointer (and not the@./node_modules/...agent import), and thatAGENTS.mdincludes the## Project notessection. All 15 scaffold tests pass;AGENTS.mdstays under the 2000-byte cap.A single-sentence
create-tesserapatch changeset covers both additions (bumps both packages via the fixed group).🤖 Generated with Claude Code