Skip to content

Improve open-source presentation and contributor onboarding - #1

Merged
mohitkale merged 3 commits into
mainfrom
codex/open-source-launch-readiness
Jul 23, 2026
Merged

mohitkale merged 3 commits into
mainfrom
codex/open-source-launch-readiness

Conversation

@mohitkale

@mohitkale mohitkale commented Jul 23, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • add a deterministic --demo mode that renders all six providers from synthetic, in-memory data without reading provider files, starting provider processes, making provider requests, or saving settings
  • reposition the README around a local-first product outcome, real UI screenshots, a walkthrough GIF, privacy architecture, supported providers, and OS-specific quick starts
  • show the explicit provider-permission and compact-mode screens directly, clarify credential handling and provider availability, and add audience and organic-growth calls to action
  • add contributor-facing issue forms, a PR template, roadmap, changelog, code of conduct, trademark guidance, collector CLI documentation, and repeatable demo-capture instructions
  • update verification and security documentation to reflect the current UI contract and hosted CI coverage

Product presentation

The README now leads with the real application rather than implementation details. The screenshots and GIF use synthetic data and cover detailed mode, compact mode, and provider settings.

Privacy and security

  • demo state exists only in memory
  • demo mode does not initialize real provider collectors or persistent settings
  • the UI explicitly labels the session Synthetic demo · no provider access
  • provider access remains opt-in and the privacy boundaries are documented visually
  • no public binaries are introduced by this PR

Verification

  • python3 scripts/security_audit.py — passed; 68 files scanned and no findings
  • PYTHONPATH=src python3 -m unittest discover -s tests -v — 81 tests passed; 2 Windows-only tests skipped on macOS
  • python3 -m compileall -q src scripts tests — passed
  • packaged GUI smoke test — detailed 472x456, compact 340x200
  • default-deny GUI smoke test — detailed 472x170, compact 340x170
  • local Markdown links, issue-form YAML, privacy SVG, and git diff --check — passed

Intentionally left for release work

  • code signing and notarization
  • release checksums and platform security-install guidance
  • release SBOM/provenance and fully hash-locked build inputs
  • repository-level GitHub settings such as description, topics, social preview, Discussions, and private vulnerability reporting

Review focus

  1. Does the README explain the product clearly enough for a first-time visitor?
  2. Are the privacy claims precise and appropriately scoped?
  3. Is the offline demo behavior acceptable as the canonical screenshot/review path?
  4. Do the public support and roadmap expectations match the project you want to operate?

@mohitkale
mohitkale marked this pull request as ready for review July 23, 2026 20:58
mohitkale and others added 3 commits July 24, 2026 02:35
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
@mohitkale
mohitkale force-pushed the codex/open-source-launch-readiness branch from c659c28 to 36193e1 Compare July 23, 2026 21:05
@mohitkale
mohitkale merged commit c1029b6 into main Jul 23, 2026
10 checks passed
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.

1 participant