Skip to content

Add MAINTAINING.md - #33

Merged
jeremyandrews merged 2 commits into
mainfrom
docs/maintaining
Sep 15, 2026
Merged

jeremyandrews merged 2 commits into
mainfrom
docs/maintaining

Conversation

@jeremyandrews

Copy link
Copy Markdown
Member

This package's own maintenance facts: the entry points, and which surface the unit tests actually cover against which is demo-verified.

One fact, one place: anything true of more than one Scolta repo lives in scolta-core/MAINTAINING.md (tag1consulting/scolta-core#63), and this file links there instead of repeating it.

Where the repo contradicted the notes this was drafted from

  • "The four Nuxt runtime route handlers have no tests" was half right and misleading as written. The four files under src/runtime/ are not exercised by any test here (runtime-memoization.test.ts covers src/runtime/util.ts only), but this repo's CLAUDE.md records that the module and its Nitro routes are verified end to end by the demo. Stated as a bare coverage gap it reads as untested; stated accurately it tells a maintainer that a change to those four files is demo-verified rather than CI-verified, which is the thing worth knowing.
  • The notes gave CI as tsc and tests. There is one test job across Node 20 and 22 running build, test, typecheck, lint, check:publish and check:pack.
  • Added from CLAUDE.md, because it costs an afternoon: never run plain npm install while the local scolta symlink exists, since npm's tree repair drops esbuild's platform binary.
  • The notes wrote the binding requirement as scolta@^X.Y.0; the doc does not pin a number, per the shared guide's rule about floors in prose.

This repo has no pull-request template, so no template line was added.

What lives only here: the entry points, and which surface the unit tests
actually cover against which is demo-verified.

The facts true of more than one Scolta repo stay in scolta-core's shared
MAINTAINING.md, RELEASING.md, REGRESSION.md and ASSETS.md; this file links
there rather than repeating them.
@github-actions

github-actions Bot commented Aug 14, 2026 •

Copy link
Copy Markdown

Summary

Adds a MAINTAINING.md file documenting maintenance facts specific to the scolta-nuxt package, including versioning, publishing, CI checks, release ordering, and known gotchas (untested Nitro routes, ambient peer types, symlink dev workflow, file: dependency trap). It links out to shared docs in scolta-core rather than duplicating cross-repo conventions.

Type: docs
Effort: 1/5 — single new markdown file, no code changes

Walkthrough

File Change Summary
MAINTAINING.md Added Documents scolta-nuxt-specific maintenance facts, versioning, release order, and caveats

Related Issues & PRs

No related issues identified.


AI Review Summary — generated by ai-pr-review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Review: Approved

No findings above the confidence threshold. The changes look good.

Token usage by agent
Agent Model Input Output Cache Write Cache Read Total Est. Cost
silent-failure-hunter Sonnet 5 5394 146 / 16384 1095 0 6635 $0.0224
code-reviewer Sonnet 5 6177 180 / 16384 1095 0 7452 $0.0253
Total 11571 326 2190 0 14087 $0.0477

AI Review — generated by ai-pr-review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Review: Approved

No findings above the confidence threshold. The changes look good.

Token usage by agent
Agent Model Input Output Total Est. Cost
code-reviewer Sonnet 5 6335 60 / 16384 6395 $0.0199
Total 6335 60 6395 $0.0199

AI Review — generated by ai-pr-review

@jeremyandrews
jeremyandrews merged commit 076cdaf into main Sep 15, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant