Skip to content

Launch readiness #16

Closed
Closed

Description

@MehdiMamas

Goal: make this repo ready for a public launch. Each row is one check; the fixes land in one PR (a separate package-manager PR first where noted).

Package manager: npm (package-lock.json:1) - separate pnpm PR first

# Check Now Evidence
1 Demo GIF or screenshot at top of README partial README.md: 5:![Banner](Assets/Banner.png)
2 One-line pitch as README first line to review README.md:1
3 Same pitch as repo description "Hide your windows from all screen capture methods! Originally based on zCri/HideMyWindows." gh repo view
4 One-command install to review README.md
5 License Other LICENSE.txt
6 5-10 topics 8 topics gh repo view
7 Social preview .github/social-preview.png 1280x640 missing upload needs Settings > Social preview (web UI, manual)
8 Green CI check.yml release.yml ; last run: success .github/workflows
9 Tagged release with notes v2.3.3 gh release list
10 CONTRIBUTING.md present (CONTRIBUTING.md) repo root
11 Issue templates missing .github/ISSUE_TEMPLATE
12 PR template missing .github/
13 3-5 good first issues 0 open gh issue list
14 Discussions enabled false gh repo view
15 Secret scan of full history not run gitleaks, summary kept private
16 Credit for original/upstream to review README.md

Activity

  1. MehdiMamas commented on Nov 5, 2026

    @MehdiMamas
    OwnerAuthor

    Plan

    Bring the repo up to the launch checklist in this issue's table, in one PR (plus a prior pnpm PR where noted).

    Files:

    • README.md: one-line pitch first, demo image/GIF at top (docs/images/demo.*), one-command install, upstream credit kept
    • .github/social-preview.png (1280x640)
    • CONTRIBUTING.md, .github/ISSUE_TEMPLATE/*, .github/PULL_REQUEST_TEMPLATE.md (only those missing)
    • LICENSE (only if missing; an existing one is kept)
    • .github/workflows/ci.yml (only if missing and there is something to check)
    • package.json, pnpm-lock.yaml, .github/workflows/*, AGENTS.md: separate first PR moving npm to pnpm (pnpm import)
      Repo settings (no files): description = README pitch, 5-10 topics, Discussions on, 3-5 good first issues, tagged release with notes if none.

    Tests: existing test/lint/build commands pass locally and in CI; README install command run once in a clean directory; demo frames inspected.
    Done when: every row of the table is checked or marked manual (social preview upload in Settings), CI is green, the PR is merged and a release exists.

  2. MehdiMamas commented on Nov 5, 2026

    @MehdiMamas
    OwnerAuthor

    Plan review

    Problems found:

    1. pnpm PR file list is incomplete. Also references to npm in: src-tauri/tauri.conf.json:9-10 (beforeDevCommand/beforeBuildCommand call npm run), BUILDING.md:9,17,60,63,80, CONTRIBUTING.md:33, .claude/skills/release/SKILL.md:18,22 (npm version edits package-lock.json, npm ci), and .github/workflows/release.yml:98 (npm ci) plus check.yml:32. The workflows also need a pnpm setup step (pnpm/action-setup) before setup-node (check.yml:17-19), which the Plan does not mention.
    2. License: the file is LICENSE.txt (Commons Clause, LICENSE.txt:1), GitHub shows "Other", and package.json says "license": "MIT". The Plan says "LICENSE only if missing", so this mismatch is never resolved or checked; row 5 would stay "Other" with no step to fix or accept it.
    3. README row 2: line 1 is the title (README.md:1) and the pitch is at line 8 after a language bar and banner; the Plan does not say whether the pitch moves up or the title line counts. Row 3 (repo description) currently contains the upstream credit, so the Plan needs to say it is changed to the exact README pitch.
    4. Row 1: the Plan names docs/images/demo.* but not how the demo is produced. The app is Windows-only, so capturing and inspecting it cannot happen on a Linux box; say where it is recorded. The existing Assets/Banner.png is the current convention, and docs/images/ does not exist.
    5. Row 4: the README install is a download-the-installer table (README.md:34-42), not a command. The Plan does not say what the one-command install is (e.g. winget, which only works if a package exists), and "run once in a clean directory" cannot verify a Windows installer on Linux.
    6. Row 15 (secret scan of full history with gitleaks) and row 13's issue content have no step in the Plan, and Done-when only covers "every row", not how row 15's summary is kept.
    7. Tests/Done-when: "existing test/lint/build commands" are not named. They are npm run build, npm test, cargo fmt --all -- --check, cargo clippy ... -D warnings, cargo test --locked -p hmw-core -- --test-threads=1 (.claude/skills/release/SKILL.md:22, check.yml), which need Windows; CI runs on windows-latest only.
    8. Row 9: a release v2.3.3 already exists; the Plan says "if none", fine, but Done-when "a release exists" is already true, so it checks nothing new.
    9. No "Alternatives" section is needed (no new platform or library chosen); the pnpm switch is set by the owner.
  3. MehdiMamas commented on Nov 5, 2026

    @MehdiMamas
    OwnerAuthor

    Plan (revised after review)

    Two PRs: pnpm first, merged before the launch PR.

    PR 1, pnpm: pnpm import, delete package-lock.json, add packageManager; replace npm in src-tauri/tauri.conf.json:9-10, BUILDING.md, CONTRIBUTING.md:33, .claude/skills/release/SKILL.md:18,22, and the npm ci steps in release.yml:98 and check.yml:32 (add pnpm/action-setup); AGENTS.md says pnpm. Done when: CI green (check.yml, windows-latest: pnpm build, pnpm test, cargo fmt --check, cargo clippy, cargo test -p hmw-core).

    PR 2, launch:

    • Licence: the file is LICENSE.txt (Commons Clause) and package.json says MIT. Keep the original licence and the "originally based on zCri/HideMyWindows" credit; make package.json and README state the licence that LICENSE.txt actually grants.
    • README.md: pitch on line 1 (same text as the repo description), banner and badges below. Windows-only app, so the demo docs/images/demo.gif is built from real screenshots/frames of the app if obtainable without Windows; otherwise from the repo's existing images, honestly labelled, and the PR says what is manual. Install: the installer table stays; add the exact download-and-run steps (a winget/scoop command only if a manifest really exists), no invented command.
    • .github/social-preview.png 1280x640, size checked with identify; upload manual.
    • CONTRIBUTING.md and templates only if missing.
    • Release: v2.3.3 exists; no new release.
    • Settings: description, 5-10 topics, Discussions on, 3-5 good first issue issues with file:line and Done when.
    • Secret scan: gitleaks, full history, findings never posted publicly.

    Done when (commands): gh repo view MehdiMamas/HideMyWindows --json description,repositoryTopics,hasDiscussionsEnabled; gh issue list -R MehdiMamas/HideMyWindows -l 'good first issue' shows 3-5; gh run list -R MehdiMamas/HideMyWindows -L 1 success; identify .github/social-preview.png 1280x640; both PRs merged.

  4. linked a pull request that will close this issueUse pnpm instead of npm #17on Nov 5, 2026
  5. MehdiMamas commented on Nov 5, 2026

    @MehdiMamas
    OwnerAuthor

    Plan decided: two PRs, pnpm first. pnpm commit pushed on branch pnpm-migration; local pnpm install, build and test pass (31 tests). Waiting on CI.

  6. MehdiMamas commented on Nov 5, 2026

    @MehdiMamas
    OwnerAuthor

    Status: pnpm PR is #17 (commit 5270b04), CI running. Launch branch launch-readiness has commit 35b77f4 (README pitch and demo image, install steps, social preview, issue and PR templates). Description set, Discussions on, 4 good first issues open (#18-#21), full-history secret scan clean.

  7. linked a pull request that will close this issuePrepare for a public launch #22on Nov 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions