chore: release-readiness hygiene (attribution, CHANGELOG, CONTRIBUTING, dependabot)#75
Merged
Merged
Conversation
…G, dependabot) Closes the easy 1.0 should-haves from the roadmap (#68): - License compliance: add NOTICE + THIRD-PARTY-NOTICES.md, and embed the bundled Chart.js + @dagrejs/dagre (MIT) notices into the built dist/sql.html. esbuild strips legal comments (legalComments:'none'), so build/build.mjs now injects the notices as a leading, sanitized HTML comment via a template token. - Add CHANGELOG.md (Keep a Changelog; seeded from v0.1.0–v0.1.4). - Add CONTRIBUTING.md (human-facing distillation of the CLAUDE.md hard rules + build/test quickstart). - Add .github/dependabot.yml (npm + github-actions, weekly) — the two runtime deps ship inside the artifact, so keep them watched. The two larger should-haves are tracked as issues instead: accessibility pass (#73) and in-app version/build stamp (#74). npm test green (1023); build verified to embed both notices. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019kE9qbgBNBrfNgwg9fRsMJ
The trivial 1.0 nice-to-haves (roadmap #68): - .github/ISSUE_TEMPLATE/ (bug + feature) and PULL_REQUEST_TEMPLATE.md (the contributor checklist), CODEOWNERS for default review routing. - <noscript> message in the template so a JS-disabled browser sees an explanation instead of a blank page. (prefers-reduced-motion folds into the a11y issue #73; the desktop-only note into the support-matrix issue #71; the design/ dir is a separate decision.) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019kE9qbgBNBrfNgwg9fRsMJ
The `design/` handoff bundle (~248K of React .jsx + HTML mockups) was "reference only" and never built/shipped. It's confusing next to the vanilla no-framework production app, so remove it from the public repo (history retains it; the external "Altinity Play" Claude Design project remains the design SoT). Updated the two README references accordingly. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019kE9qbgBNBrfNgwg9fRsMJ
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.
Closes the easy 1.0 should-haves from the roadmap (#68). The two larger ones are tracked as issues: accessibility pass (#73) and in-app version/build stamp (#74).
License compliance (the real gap)
The build inlines two MIT deps (Chart.js, @dagrejs/dagre) but esbuild was stripping their license banners (
legalComments: 'none'), so the shippeddist/sql.htmlcarried no attribution — an MIT-compliance gap.NOTICE+THIRD-PARTY-NOTICES.md(both MIT texts, with versions 4.5.1 / 3.0.0).build/build.mjsnow embeds those notices as a leading, sanitized HTML comment indist/sql.html(via a<!--__THIRDPARTY__-->template token;--runs are collapsed so the text can't close the comment early). Verified present in the artifact.Project hygiene
CHANGELOG.md— Keep a Changelog, seeded from v0.1.0–v0.1.4 + an[Unreleased]section.CONTRIBUTING.md— human-facing distillation of theCLAUDE.mdhard rules (coverage gate, layer discipline, two-deps rule) + a build/test quickstart..github/dependabot.yml— npm + github-actions, weekly (the two runtime deps ship inside the artifact, so keep them watched).Verification
npm run buildsucceeds;dist/sql.htmlcontains both MIT notices, the comment is well-formed, and<!DOCTYPE html>is still line 1.npm testgreen (1023 tests); coverage gate unaffected (nosrc/logic changed).🤖 Generated with Claude Code
https://claude.ai/code/session_019kE9qbgBNBrfNgwg9fRsMJ