Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.22 KB

File metadata and controls

39 lines (26 loc) · 1.22 KB

Contributing

Thanks for helping. protestchat is security software for people under stress — careful changes matter more than fast ones.

Before you start

  1. Read docs/THREAT-MODEL.md and docs/FORWARD-SECRECY.md if you touch crypto, mesh, or BLE.
  2. Prefer a focused PR that closes one issue over a kitchen-sink patch.
  3. If you change user-visible mode warnings or safety claims, update the user guide in website/ in the same PR (docs-as-code — see #11).

Setup

npm install
npm run doctor    # names toolchain fixes
npm test
npm run typecheck

Expo Go will not work (custom native BLE). Use a development build:

npm run android   # or npm run ios

Pull requests

  • Keep the diff reviewable; separate unrelated fixes into separate PRs.
  • Add or update tests for protocol/crypto/mesh behavior.
  • Do not claim new security properties in the README or user site without threat-model updates.
  • Fill in the PR template.

Security reports

Do not open a public issue for an exploitable vulnerability. See SECURITY.md.

Code of Conduct

Participation is governed by CODE_OF_CONDUCT.md.