Add security sanitizer, opt-in telemetry, and contributor guidelines

Infrastructure:
- security/: PII sanitizer with scan/sanitize modes, pre-commit hook, configurable blocklists
- telemetry/: GStack-style opt-in usage analytics, local stats viewer, version checker
- CONTRIBUTING.md: Privacy-first contributor guidelines with anonymization rules
- VERSION: 1.0.0

README updated with Privacy & Security and Telemetry sections.
This commit is contained in:
Alfred Claw 2026-03-31 08:41:35 -07:00
parent 36d6ed83e7
commit d4c8c21cb3
12 changed files with 1402 additions and 4 deletions

View file

@ -137,15 +137,56 @@ ai-marketing-skills/
---
## 🔒 Privacy & Security
Every skill is built with data privacy in mind:
- **PII Sanitizer** scans code and data for sensitive information before commits (`security/sanitizer.py`)
- **Pre-commit hook** blocks commits containing detected PII patterns
- **Configurable blocklists** for company names, person names, and custom patterns
- See [`security/README.md`](./security/README.md) for setup
```bash
# Scan for sensitive data
python3 security/sanitizer.py --scan --dir . --recursive
# Install the pre-commit hook
cp security/pre-commit-hook.sh .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
```
---
## 📡 Telemetry (Opt-In)
Anonymous usage telemetry helps us understand which skills people actually use. Fully opt-in, privacy-first:
- **Local logging always** — see your own usage stats in `~/.ai-marketing-skills/analytics/`
- **Remote reporting optional** — only if you explicitly opt in on first run
- **Data collected:** skill name, duration, success/fail, version, OS. Nothing else. No code, no file paths, no repo content.
- **Version checks** — get notified when new skills are available
```bash
# View your local usage stats
python3 telemetry/telemetry_report.py
# Check for updates
python3 telemetry/version_check.py
```
See [`telemetry/README.md`](./telemetry/README.md) for details.
---
## 🤝 Contributing
Found a bug? Have an improvement? PRs welcome.
Found a bug? Have an improvement? PRs welcome. Read [`CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines.
1. Fork the repo
2. Create your feature branch (`git checkout -b feature/better-scoring`)
3. Commit your changes
4. Push to the branch
5. Open a Pull Request
3. Run `python3 security/sanitizer.py --scan` before committing
4. Commit your changes
5. Push to the branch
6. Open a Pull Request
---