Repository navigation
Fold CONVENTIONS.md into CONTRIBUTING.md and delete it - #38
Merged
Merged
Conversation
CONVENTIONS.md was written to explain which scaffolding conventions came from a reference project and which the brief overrode. That framing is useful to nobody but the author now. The conventions themselves are still binding, so they move; the provenance goes. Moved into CONTRIBUTING.md, all fifteen conventions, rewritten without the comparisons: ESM setup and .js relative imports, packages resolving to TypeScript source, engines, the strict tsconfig flags, ESLint with no formatter and the style rules that replace one, single-root Vitest, file-header comment style, script naming, root scripts delegating to the owning package, greppable CLI failure output, tolerant reads with strict writes, invariants enforced by tests rather than review, docs formatting, and .context being gitignored. Dropped: the reference-project narrative, the table of what the brief overrode, and three decisions-log rows that only recorded that provenance. The table's substance survives elsewhere in the same file, in the engines and tsconfig conventions and the Layout block, so nothing operational was lost. The remaining ten decisions-log rows are design constraints a contributor still has to work within, so they move intact. References removed from CONTRIBUTING.md in both places. The README stopped linking to it when the document index moved. PR bodies 1, 14 and 16 were edited to drop their links. pnpm check passes with 229 tests, pnpm validate passes with 200 threads, 273 loops and 510 spans all resolving.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
CONVENTIONS.md existed to explain which scaffolding conventions came from a reference project and which the brief overrode. That framing is useful to nobody but the author now. The conventions themselves still bind, so they move. The provenance goes.
Moved into CONTRIBUTING.md
All fifteen conventions, rewritten without the comparisons:
.json relative importssrc/index.ts, notdist/engines, Node 20,packageManagerstrict: true, with the five flags namednoUncheckedIndexedAccessis load-bearing formessages[].context/is gitignoredDropped
The dropped table listed Node 20 + pnpm, Vitest, the
packages/*+apps/*shape, and strict TypeScript. Every one of those survives elsewhere in the same file, in the engines convention, the Vitest convention, the Layout block and the strict-tsconfig convention, so nothing operational was lost. The no-linter reversal nets out to "ESLint yes, formatter no", which the Conventions prose now states directly.The remaining ten decisions-log rows are design constraints a contributor still has to work within (spans validated inside
ThreadSchema, UTF-16 offsets, bucket in thethread_idprefix,splitstored per thread, quoted-substring authoring, IoU matching, three thresholds, prediction format living in eval, generated fixtures, committedresults/). They move intact.References removed
CONTRIBUTING.md, both places: the Conventions pointer and the document-index rowZero
CONVENTIONSorgstackreferences remain anywhere in the repo.Verification
pnpm check: 229 tests passingpnpm validate: 200 threads, 273 loops, 510 spans, all resolve. PASSScaffolding-era leftovers found elsewhere are reported in the PR discussion rather than changed here, per the brief.
🤖 Generated with Claude Code