Repository navigation
chore: open-source readiness cleanup - #19
Merged
Merged
Conversation
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)
This was referenced Oct 17, 2026
Closed
Deploying machinelearning101 with
|
| Latest commit: |
865bf66
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0f85d1f4.machinelearning101.pages.dev |
| Branch Preview URL: | https://chore-opensource-readiness.machinelearning101.pages.dev |
Avoids the Node 20 deprecation warning on GitHub Actions runners.
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.
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
README.md: live-site link to https://machinelearning101.com frontand 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 nowresolve.
docs/DIRECTORY_LISTINGS.md— verified opportunities to submit the projectto curated awesome-lists / learning directories (tracked in Submit project to curated awesome-lists and learning directories #1).
🧩 Standard community files (new)
LICENSECONTRIBUTING.mdCODE_OF_CONDUCT.mdSECURITY.md.github/PULL_REQUEST_TEMPLATE.md.github/ISSUE_TEMPLATE/config.yml.editorconfig,.nvmrcdocs/CONTRIBUTING.mdnow points at the root guide (single source of truth), andthe bug/feature issue templates set titles and auto-labels.
🛡️ Safeguards
.github/workflows/ci.yml— two blocking jobs,Type-check & testandBuild, each runningnpm cifirst. Node version comes from.nvmrc. Acommented-out
workerjob is included for the Cloudflare Worker sub-project;it is disabled until that sub-project's own checks are green (Worker (worker/) has 28 failing tests and ~24 type errors; add it to CI once green #18).
type-checkscript toworker/package.json.🐛 Pre-existing blockers fixed
npm installfailed on a clean clone.package-lock.jsonpinnednuxt-component-meta(transitive via@nuxt/content) to a deadpkg.pr.newpreview URL that now 404s. Repointed to the npm registry —npm cinow succeeds. (Closes npm install fails on a fresh clone: lockfile pins nuxt-component-meta to a dead pkg.pr.new URL #2)npm run type-checkreported 1611 errors.nuxt.config.tsoverrode thepath aliases with relative values; Nuxt writes them verbatim into
.nuxt/tsconfig.*.json, so~/*resolved to.nuxt/*. Aliases are nowabsolute (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
overridemodifiers. Remaining type errors and thefailing tests were then fixed so all CI checks pass.
with
pinia.use()until the instance is installed into a Vue app, which thetests never did — so the persistence plugin never ran. Added
tests/helpers/pinia.tsand corrected stale test setup.🔧 Repo settings
🤝 Contributor enablement
18 issues were opened to invite contributions, labelled
help wanted/good first issue(#1–#18) — from architecture and performance work through toeasy documentation fixes.
✅ Verification
All checks pass locally (Node 22, from a clean
npm ci):npm cipkg.pr.newURLnpm run type-checknpm run testnpm run buildTotal errors: 0)No
@ts-ignore,@ts-expect-erroror blanketanywere added, and thetype-check configuration was not weakened.
Notes for reviewers
components/visualizations/VisualizationErrorBoundary.vuewas committedtruncated (2 lines) in
HEADand is referenced nowhere; it has beenreconstructed as a minimal, valid error-boundary component rather than
deleted.
worker/is excluded from the app type-check because it is a separatesub-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.