.github/CONTRIBUTING.md

61 lines · Markdown
1# Contributing to SophaxChat
2
3Thanks for your interest in contributing. SophaxChat is a security-focused project — please read this before submitting code.
4
5## Philosophy
6
7This project has a formal philosophy document. **Read [PHILOSOPHY.md](../PHILOSOPHY.md) before contributing.** By submitting a pull request, you agree to its principles.
8
9The short version:
10
11- **No servers.** Every feature must work without a central server.
12- **No accounts.** Identity is cryptographic, not email/phone-based.
13- **No tracking.** No analytics, no crash reporters that phone home.
14- **Minimal dependencies.** Every dependency is a potential attack surface.
15
16## Building
17
18### iOS / macOS
19
20Prerequisites: Xcode 15+, XcodeGen.
21
22```bash
23brew install xcodegen
24xcodegen generate
25open SophaxChat.xcodeproj
26```
27
28Press **⌘R** to build and run. A physical device is required for MultipeerConnectivity (Simulator does not support P2P).
29
30The core library (`SophaxChatCore`) can be built without Xcode:
31
32```bash
33swift build
34swift test
35```
36
37### Android
38
39Prerequisites: Android Studio Meerkat or later, JDK 17+.
40
41```bash
42cd android
43./gradlew assembleDebug
44```
45
46See [`android/README.md`](../android/README.md) for details on the Android port status.
47
48## Protocol compatibility
49
50The iOS and Android apps must interoperate. Any change to the wire format must be documented in [`docs/protocol.md`](../docs/protocol.md) and must maintain backward compatibility or include a versioning mechanism.
51
52## Security issues
53
54Do **not** open a public GitHub issue for security vulnerabilities. See [`SECURITY.md`](../SECURITY.md) for responsible disclosure instructions.
55
56## Pull requests
57
58- Keep PRs focused — one feature or fix per PR.
59- Include a brief description of *why*, not just *what*.
60- Crypto changes require a clear explanation of the security model impact.
61- All Swift code must compile with strict concurrency checking (`-strict-concurrency=complete`).