Skip to content

CHECKLIST.md

Latest commit

 

History

History
21 lines (18 loc) · 2.61 KB

CHECKLIST.md

File metadata and controls

21 lines (18 loc) · 2.61 KB

Cheri App Publish Checklist

  • [PASS] README.md quality: README.md exists and is detailed enough for installation, usage, backend setup, invite testing, task behavior, and known limitations.
  • [PASS] PUBLISHING.md present: PUBLISHING.md exists and gives a concise maintainer publication flow.
  • [PASS] EXPORT_REPORT.md present: EXPORT_REPORT.md exists and explains what was copied, excluded, and sanitized.
  • [PASS] .gitignore coverage: .gitignore covers runtime state, credentials, local overrides, Wrangler residue, logs, smoke-test files, build output, and editor junk.
  • [PASS] secret/runtime residue check: no obvious credentials.json, state.json, tasks.json, task-runtime.json, task-logs.json, or raw deployment snapshot files are included.
  • [PASS] wrangler/generated residue check: no .wrangler/ directory or similar generated deployment state was found in cheri-app/.
  • [PASS] junk/temp file check: no local logs, smoke-test leftovers, temp zips, .DS_Store, or Thumbs.db files were found in the export.
  • [PASS] install instructions: the README install flow matches the exported structure and the repo includes setup.py, package.json, the CLI source, and the Worker source.
  • [WARN] global CLI instructions: the instructions are realistic and note the Windows PATH caveat, but this fast pass did not re-run a fresh install from the cleaned export itself.
  • [PASS] command examples: the README examples match the current CLI tree, including workspace join, file upload/download/list, teams invite/list/invite-reset, and task create/start/stop/run/logs.
  • [PASS] backend config docs: backend URL discovery, CLI override commands, Worker deployment, and KV/R2 bindings are documented and not misleading for a public repo.
  • [PASS] invite flow docs: the README includes a usable two-user invite and collaboration test flow.
  • [PASS] task docs: task auto-start, start / stop, folder lookup behavior, and current limitations are documented honestly.
  • [PASS] provider docs: System (recommended) is clearly documented as the only public-ready provider, and the other providers are marked as coming soon.
  • [PASS] folder publishability: the cheri-app/ structure is clean, understandable, and limited to source, backend, docs, tests, and minimal project metadata.

Final Verdict

cheri-app/ looks ready for GitHub upload. The folder is clean, publishable, and does not include obvious secrets or local runtime residue. The only caution from this fast pre-publish pass is that global CLI install behavior was validated by structure and documentation rather than by a fresh install/run directly from the exported folder.