Skip to content

chore: open-source readiness cleanup - #19

Merged
marvelefe merged 3 commits into
mainfrom
chore/opensource-readiness
Oct 17, 2026
Merged

marvelefe merged 3 commits into
mainfrom
chore/opensource-readiness

Conversation

@marvelefe

@marvelefe marvelefe commented Oct 17, 2026 •

Copy link
Copy Markdown
Owner

Summary

Open-source readiness pass ahead of making the repository public: documentation,
standard GitHub community files, automated safeguards, and fixes for several
pre-existing blockers that would have stopped anyone from contributing.

📄 Documentation

  • Rewrote README.md: live-site link to https://machinelearning101.com front
    and centre, corrected badges, accurate project structure, docs index, and
    Contributing/Code of Conduct/Security sections. Removed links to files that do
    not exist (.kiro/steering/*, docs/ANALYTICS_SETUP.md); all relative links now
    resolve.
  • Added docs/DIRECTORY_LISTINGS.md — verified opportunities to submit the project
    to curated awesome-lists / learning directories (tracked in Submit project to curated awesome-lists and learning directories #1).

🧩 Standard community files (new)

File Purpose
LICENSE MIT (the README claimed MIT but no licence file existed)
CONTRIBUTING.md Canonical contributor guide at the repo root
CODE_OF_CONDUCT.md Contributor Covenant v2.1
SECURITY.md Private vulnerability reporting, scope, safe harbour
.github/PULL_REQUEST_TEMPLATE.md Structured PR template
.github/ISSUE_TEMPLATE/config.yml Disables blank issues; routes questions/security/docs
.editorconfig, .nvmrc Editor + Node version hygiene

docs/CONTRIBUTING.md now points at the root guide (single source of truth), and
the bug/feature issue templates set titles and auto-labels.

🛡️ Safeguards

🐛 Pre-existing blockers fixed

  1. npm install failed on a clean clone. package-lock.json pinned
    nuxt-component-meta (transitive via @nuxt/content) to a dead
    pkg.pr.new preview URL that now 404s. Repointed to the npm registry —
    npm ci now succeeds. (Closes npm install fails on a fresh clone: lockfile pins nuxt-component-meta to a dead pkg.pr.new URL #2)
  2. npm run type-check reported 1611 errors. nuxt.config.ts overrode the
    path aliases with relative values; Nuxt writes them verbatim into
    .nuxt/tsconfig.*.json, so ~/* resolved to .nuxt/*. Aliases are now
    absolute (fixed ~1345 errors). Also excluded the separate worker/
    sub-project from the app's type-check (it has its own tsconfig/types/deps),
    and added the 58 missing override modifiers. Remaining type errors and the
    failing tests were then fixed so all CI checks pass.
  3. Persistence unit tests could never pass. Pinia defers plugins registered
    with pinia.use() until the instance is installed into a Vue app, which the
    tests never did — so the persistence plugin never ran. Added
    tests/helpers/pinia.ts and corrected stale test setup.

🔧 Repo settings

  • Enabled GitHub Discussions (the new issue-template config links to it).
  • Added 14 discoverability topics (was 2).

🤝 Contributor enablement

18 issues were opened to invite contributions, labelled help wanted /
good first issue (#1–#18) — from architecture and performance work through to
easy documentation fixes.

✅ Verification

All checks pass locally (Node 22, from a clean npm ci):

Check Before After
npm ci ❌ 404 on a dead pkg.pr.new URL ✅ installs
npm run type-check ❌ 1611 errors ✅ 0 errors
npm run test ❌ 13 failed / 141 passed ✅ 154 passed
npm run build — ✅ succeeds (Total errors: 0)

No @ts-ignore, @ts-expect-error or blanket any were added, and the
type-check configuration was not weakened.

Notes for reviewers

  • components/visualizations/VisualizationErrorBoundary.vue was committed
    truncated (2 lines) in HEAD and is referenced nowhere; it has been
    reconstructed as a minimal, valid error-boundary component rather than
    deleted.
  • worker/ is excluded from the app type-check because it is a separate
    sub-project with its own tsconfig/runtime types/deps. Its own checks have
    pre-existing failures and are tracked in Worker (worker/) has 28 failing tests and ~24 type errors; add it to CI once green #18.

Prepare the repository for public contribution: documentation, standard
GitHub community files, automated safeguards, and fixes for pre-existing
blockers that stopped the project from installing or being contributed to.

Docs & community files
- Rewrite README (live-site link, accurate structure, no dead links)
- Add LICENSE (MIT), CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md
- Add PULL_REQUEST_TEMPLATE, issue-template config, .editorconfig, .nvmrc
- Add docs/DIRECTORY_LISTINGS.md (curated listing opportunities)

Safeguards
- Add CI workflow (type-check, test, build) gated on all three checks
- Add worker type-check script

Fixes
- Fix npm install: repoint dead pkg.pr.new lockfile entry to the registry
- Fix type-check: absolute path aliases (was resolving to .nuxt/), exclude
  the separate worker/ sub-project, add missing override modifiers, resolve
  remaining type errors (1611 -> 0) without weakening the check
- Fix persistence tests: install Pinia into a Vue app so the persisted-state
  plugin actually runs; correct stale async/API usage (13 failing -> 0)
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Deploying machinelearning101 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 865bf66
Status: ✅  Deploy successful!
Preview URL: https://0f85d1f4.machinelearning101.pages.dev
Branch Preview URL: https://chore-opensource-readiness.machinelearning101.pages.dev

View logs

@marvelefe
marvelefe merged commit 8616ffe into main Oct 17, 2026
3 checks passed
@marvelefe
marvelefe deleted the chore/opensource-readiness branch October 17, 2026 12:34
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.

npm install fails on a fresh clone: lockfile pins nuxt-component-meta to a dead pkg.pr.new URL

1 participant