Skip to content

docs: SECURITY, CONTRIBUTING, unsigned-build note - #1

Merged
SPhillips1337 merged 1 commit into
mainfrom
docs/public-polish
Nov 10, 2026
Merged

SPhillips1337 merged 1 commit into
mainfrom
docs/public-polish

Conversation

@SPhillips1337

Copy link
Copy Markdown
Contributor

Polish now that the repo is public.

  • SECURITY.md: report through private vulnerability reporting (now enabled on the repo). It also describes the security model (preload bridge, path validation, no-shell spawn, key in main safeStorage) and a table of where audio goes for each speech engine. src/shared/endpoints.ts already referenced this file.
  • CONTRIBUTING.md: setup, npm run ci, a manual smoke test, and the IPC and docs rules from AGENTS.md.
  • README: Windows-only packaging, a SmartScreen "Run anyway" note for unsigned builds, and links to the new docs.
  • src/shared/speech-server.ts: the error-message example used a LAN address (10.0.10.46); it now uses 127.0.0.1:8080, matching the default.

Repo topics added separately.

Verification: npm run ci passes (typecheck, 119 tests, build).

🤖 Generated with Claude Code

- SECURITY.md: private reporting, security model, where data goes
  (src/shared/endpoints.ts already pointed at this file)
- CONTRIBUTING.md: setup, `npm run ci`, IPC and docs rules
- README: unsigned-build SmartScreen note, link new docs
- Replace a LAN IP in a speech-server error example with loopback

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR adds SECURITY.md, CONTRIBUTING.md, updates README.md with Windows packaging/SmartScreen guidance and new doc links, and fixes an example LAN IP address in an error message in src/shared/speech-server.ts.

All changes are correct and there are no blocking defects. The documentation is accurate and consistent — SECURITY.md correctly reflects the security model (preload bridge isolation, no-shell spawn, safeStorage for secrets, CSP restrictions), and CONTRIBUTING.md accurately describes the setup and IPC rules. The src/shared/speech-server.ts change replaces a private LAN address (10.0.10.46:8888) in an error message example with the loopback default (127.0.0.1:8080), which is a correct and appropriate fix for a public repo.

No issues found. ✅


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@SPhillips1337
SPhillips1337 merged commit b18e1ff into main Nov 10, 2026
2 checks passed
@SPhillips1337
SPhillips1337 deleted the docs/public-polish branch November 10, 2026 11:20
@SPhillips1337
SPhillips1337 restored the docs/public-polish branch November 10, 2026 11:21
@SPhillips1337
SPhillips1337 deleted the docs/public-polish branch November 10, 2026 11:21
SPhillips1337 added a commit that referenced this pull request Nov 10, 2026
- PROGRESS: public since 2026-11-10, archive repo pointer, #1/#2 deliveries,
  SonarCloud removal, next checks
- Spine: session checkpoint, public-identity decision, IPv6 hostname lesson

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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