Skip to content

chore: CI, issue/PR templates, package.json metadata, README windows note#124

Closed
zachdive wants to merge 1 commit intomasterfrom
eve/repo-hygiene-ci
Closed

chore: CI, issue/PR templates, package.json metadata, README windows note#124
zachdive wants to merge 1 commit intomasterfrom
eve/repo-hygiene-ci

Conversation

@zachdive
Copy link
Copy Markdown
Contributor

@zachdive zachdive commented Apr 25, 2026

Summary

Repo hygiene pass: adds CI, issue/PR templates, fixes package.json metadata, and documents the Docker Desktop requirement on Windows.

This is the first PR in an unattended ops loop Eve is running for CADAM. All Eve-authored branches are prefixed eve/... so they're easy to filter and revert. No code changes touch product surface.

Why

The repo is at 2.6k stars with no automated guardrails on PRs (no GitHub Actions workflows defined), package.json still ships the placeholder vite-react-typescript-starter / 0.0.0, and Windows users keep hitting the same wall on npx supabase start.

Closes #118.

Changes

  • .github/workflows/ci.yml: typecheck + lint + build on every PR and push to master. Concurrency-cancels in-flight runs on the same ref.
  • .github/ISSUE_TEMPLATE/{bug_report,feature_request,model_routing,config}.yml: structured templates so we get reproducible bug reports (model + prompt + browser) and contributor-friendly feature requests. Disables blank issues; surfaces Discord and the live demo as contact links.
  • .github/PULL_REQUEST_TEMPLATE.md: standard summary / why / changes / testing / risk template.
  • package.json: name -> cadam, version -> 0.1.0 (matches the v0.1.0 GitHub release), plus description, homepage, repository, bugs, author, license (GPL-3.0-or-later), keywords. No dependency or script changes.
  • README.md: adds Docker Desktop to Prerequisites with a Windows-specific note (closes npx supabase start -> error #118), corrects the "Built With" line from React 18 to React 19 (matches the actual react@19.1.0 dependency).

Testing

  • Files render correctly on the branch view.
  • CI workflow uses the existing npm run typecheck, npm run lint, npm run build scripts (no script changes needed).
  • Need a maintainer to confirm the placeholder VITE_* env values in CI don't break the build (Vite usually treats undefined import.meta.env as undefined at build time; the placeholders are belt-and-braces).
  • First PR run will show whether npm ci succeeds against package-lock.json on Node 20.

Risk

Low.

  • The package.json rename changes the name field, which could affect any downstream tool that keys off it (none known in this repo).
  • License field switched from GPL-3.0 to GPL-3.0-or-later to match the actual LICENSE text and the SPDX recommendation. If you'd rather keep it pinned to GPL-3.0, happy to revert that single change.
  • No code paths touched, no migrations, no secrets.

Follow-up PRs already queued

  1. eve/vitest-harness - Vitest setup + 4 smoke tests (mutation hooks, message service, OpenSCAD worker happy path, parameter parser).
  2. eve/regression-tests-115-113 - regression tests targeting the abort behavior in fix(chat): abort streaming fetch on unmount / stopGenerating #115 and the pending-tool-call recovery in fix(parametric-chat): prevent forever-pending tool calls after edge kill #113, then re-request review on those PRs.
  3. eve/readme-demo-gif - replace static screenshots with a 3s loop on the GitHub landing surface.

Drafted and pushed by Eve operating on Zach's full-approval grant. PR is opened as a draft - flip to ready when you've eyeballed it.


Summary by cubic

Adds CI and repo templates, fixes package.json metadata, and documents the Windows Docker requirement. No product behavior changes.

  • Refactors
    • Added CI workflow to typecheck, lint, and build on PRs and pushes to master; cancels in‑flight runs; uses Node 20 with safe VITE_* placeholders.
    • Added issue templates (bug, feature, model routing), PR template, and contact links; disabled blank issues.
    • Updated package.json: namecadam, version0.1.0, plus description, homepage, repository, bugs, author, license GPL-3.0-or-later, keywords (no deps/scripts changed).
    • Updated README.md: note that Windows needs Docker Desktop for npx supabase start and corrected React 19. Closes npx supabase start -> error #118.

Written for commit 3a4b2f4. Summary will update on new commits.

…windows note

- .github/workflows/ci.yml: typecheck + lint + build on PR/push
- .github/ISSUE_TEMPLATE/{bug_report,feature_request,model_routing,config}.yml + PR template
- package.json: name (cadam), version (0.1.0), description, homepage, repository, bugs, author, license, keywords
- README.md: flag Docker Desktop requirement on Windows (closes #118), correct React 19
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cadam Ready Ready Preview, Comment Apr 25, 2026 8:49pm

Request Review

@supabase
Copy link
Copy Markdown

supabase Bot commented Apr 25, 2026

This pull request has been ignored for the connected project sgprnbvihmydyrzvkcir because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

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.

npx supabase start -> error

1 participant