Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (25 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.63 KB
Raw

Contributing to SSC

SSC is install-only (Android APK + Windows/Mac desktop). Browser-tab chat is intentionally blocked. See InstalledClientGate.jsx.

How to help (no payment expected — thank you)

  1. Read this file and SECURITY.md.
  2. Pick a task or open Help wanted if you are unsure where to start.
  3. Fork → branch → Pull Request (use the PR template).
  4. For bugs use the bug report template.
  5. Questions → Discussions (not Issues).

Architecture: memory/SECURITY_MODEL.md · memory/SSC-ROADMAP.md

License: By contributing, you agree your work is licensed under AGPL-3.0 (same as the project). You are not entitled to payment unless we sign a separate written agreement.

Local setup (summary)

docker compose up -d
cd backend && python -m venv venv && .\venv\Scripts\pip install -r requirements.txt
copy .env.example .env   # fill MONGO_URL, JWT_SECRET
cd ..\frontend && yarn install && copy .env.example .env

See README.md for LAN APK and desktop builds.

Before you PR

  • Run cd frontend && yarn test:ci
  • Run cd backend && .\venv\Scripts\python.exe -m pytest tests/ -q (with local API if integration tests apply)
  • No secrets, personal emails, or home LAN IPs in the diff
  • Match existing code style; small PRs are easier to review

License

By contributing, you agree your contributions are licensed under the same terms as the project (AGPL-3.0). See LICENSE.