HealthProbe
/
CONTRIBUTING.md
Newer
■
■
■
■
■
■
■
■
■
■
Older
46 lines
|
1.491kb
| 1 |
# Contributing to HealthProbe |
|
| 2 | ||
| 3 |
## ⚠️ Privacy Rules — Non-Negotiable |
|
| 4 | ||
| 5 |
Before submitting any code, issue, PR, or documentation: |
|
| 6 | ||
| 7 |
**Never include:** |
|
| 8 |
- Credentials, API keys, tokens, or certificates |
|
| 9 |
- Personal data: names, emails, phone numbers, dates of birth |
|
| 10 |
- Device identifiers: UDID, serial number, advertising ID, device name |
|
| 11 |
- Account identifiers: Apple ID, iCloud account, CloudKit record IDs |
|
| 12 |
- Raw health data: actual measurements, records, or workout details |
|
| 13 |
- Location data: GPS coordinates, location history |
|
| 14 |
- Any combination of fields that could identify a person or device |
|
| 15 | ||
| 16 |
**For examples and tests, use synthetic data only:** |
|
| 17 |
``` |
|
| 18 |
Device: "iPhone-TESTDEVICE-001" |
|
| 19 |
User: "Test User" |
|
| 20 |
Date: 2000-01-01 |
|
| 21 |
Value: 0 (or clearly fictional) |
|
| 22 |
``` |
|
| 23 | ||
| 24 |
Submissions containing real credentials or personal data will be closed without review. |
|
| 25 | ||
| 26 |
--- |
|
| 27 | ||
| 28 |
## Contribution Standards |
|
| 29 | ||
| 30 |
- **Observations ≠ conclusions:** Label theories and speculation explicitly |
|
| 31 |
- **Read-only HealthKit:** No code that modifies or deletes health data |
|
| 32 |
- **Evidence-based:** Bug reports require reproduction steps, device model, and iOS version |
|
| 33 |
- **No raw health exports:** Aggregated counts only; never raw sample values |
|
| 34 | ||
| 35 |
## Bug Reports |
|
| 36 | ||
| 37 |
Include: |
|
| 38 |
- Device model (e.g., iPhone 15 Pro) — no serial/UDID |
|
| 39 |
- iOS version |
|
| 40 |
- HealthProbe version |
|
| 41 |
- Observed vs. expected behavior |
|
| 42 |
- Anonymized screenshot or export (values redacted) |
|
| 43 | ||
| 44 |
## License |
|
| 45 | ||
| 46 |
By contributing you agree your code is released under the project license. |