Sync engineering voice from canon; split repo conventions#88
Closed
moskovich wants to merge 1 commit into
Closed
Conversation
feralfile-bot
left a comment
Contributor
There was a problem hiding this comment.
Reviewers: 1 (approve: 0, comment: 1, request-changes: 0).
Optional cleanup:
.cursor/rules/06-cli-conventions.mdc:10says the file explains how the voice applies to “Go code,” but this repo is Node.js/TypeScript-first and the actual rule is Go-style documentation comments. Please reword that phrase so future agents do not infer that this repo contains or expects Go runtime code.
Contributor
Author
|
Closing — we're keeping the engineering voice internal to canon and deleting the scattered repo copies rather than vendoring/syncing them. No per-repo voice file. |
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.
Why
The engineering voice in
05-engineering-voice.mdcwas a hand-maintained paraphrase that had drifted from the canonical source. It was missing the current canon sections (truth discipline, compression tics, protocol-object naming) and was one of five inconsistent copies across repos.What
05-engineering-voice.mdcis now a generated vendor of the single source of truth:feral-file/canon→reference/voice/engineering.md. It carries a do-not-edit banner. Regenerate withmake sync-voicein canon after editing the source.06-cli-conventions.mdc(new, hand-owned) keeps the genuinely ff-cli-specific parts that were mixed into the old file: Go-doc commenting standard, repo terminology, and CLI output rules. These are not brand voice, so they live in the repo layer, not the synced file.Canon is private and this repo is public, so we vendor a generated copy rather than submodule canon. This is the model for the other repos with stale voice copies (ff-app, ff-exhibition, ff-source-resolver, feralfile-app).