Skip to content

PUBLISHING-CHECKLIST.md

Latest commit

 

History

History
64 lines (51 loc) · 3.3 KB

PUBLISHING-CHECKLIST.md

File metadata and controls

64 lines (51 loc) · 3.3 KB
Raw

Publishing Checklist

Use this before creating a public release or making a broader push for stars, users, and contributors.

Repository Metadata

  • Set the repository description to: Unofficial Android companion app and optional HTTPS/PWA proxy for T3 Code.
  • Set the website/homepage to the latest GitHub Release or the repo README
  • Add focused topics such as t3-code, android, tailscale, self-hosted, webview, pwa, remote-access, mobile-companion
  • Upload docs/images/social-preview.png as the GitHub social preview image
  • Enable Issues and Discussions if you want community support to happen in public
  • Enable private vulnerability reporting
  • Verify branch protection is active on main

README And Docs

  • Confirm the README still matches the current app behavior
  • Keep all public docs in English
  • Keep at least one current screenshot in the README
  • Keep SHOWCASE.md aligned with what the repo actually proves
  • Keep SCREENSHOTS.md aligned with the current approved asset set
  • Keep WEBVIEW-HARNESS.md aligned with the actual contributor test commands
  • Make sure no tokens, private URLs, or personal IPs appear anywhere in docs or screenshots
  • Keep the disclaimer visible

Release Asset

  • Run npm test from a clean working tree and keep the output
  • Build a fresh APK from a clean working tree
  • Install it on a second Android device
  • Test first-run pairing
  • Test pasting a full pairing link and confirm only the base URL is retained
  • Test reconnect with the saved URL
  • Test the photo upload button in a real chat
  • Capture the evidence required by RUNTIME-VERIFICATION.md
  • Note the Android version, Android System WebView version, device model, network path, and T3 Code version tested

Optional PWA Mode

  • Verify no TLS keys, certificates, .env files, or build artifacts are committed
  • Verify the proxy works with your intended PUBLIC_URL
  • Test install flow in Chrome on Android

Community Readiness

  • Create at least 3 starter issues before announcing the repo
  • Label approachable work with good first issue
  • Label broader contributor work with help wanted
  • Respond quickly to the first external bug reports and pull requests
  • Keep ROADMAP.md realistic so contributors can see where help is useful
  • Keep MAINTAINER-SETUP.md aligned with the actual GitHub settings

Release Notes

  • Confirm the package version in package.json is final
  • Tag the exact release commit with the matching version, for example v1.1.0
  • Confirm RELEASE-RUNBOOK.md is still accurate for the current workflow
  • Open or update a runtime evidence record from docs/evidence/RELEASE-EVIDENCE-TEMPLATE.md
  • Let the release workflow publish T3Code-v<version>.apk and T3Code-v<version>.apk.sha256
  • Use GitHub's automatically generated release notes, then edit the intro paragraph by hand
  • Include a short tested-on note and any known limitations
  • Link to the runtime evidence issue, PR, or release note section that records the manual Android checks
  • Link to SHOWCASE.md if you want maintainers or contributors to evaluate the project quickly
  • Link to COMPARISON.md so readers understand project scope immediately