system-prompts-and-models-o.../salesflow-saas/CONTRIBUTING.md
Claude 84762f08ab
Add complete launch infrastructure: models, APIs, agents, compliance, docs, knowledge base
Phase 1 - Repo Hardening:
- README.md, LICENSE, SECURITY.md, CONTRIBUTING.md
- GitHub Actions repo-hygiene workflow
- docs/: ARCHITECTURE, DATA-MODEL, API-MAP, AGENT-MAP, DEPLOYMENT-NOTES

Phase 2 - Database Models (7 new):
- Company, Contact, Call, Commission, Payout, Dispute, GuaranteeClaim
- Consent, Complaint, Policy, KnowledgeArticle, SectorAsset
- Updated models/__init__.py with all 32+ models

Phase 3 - API Surfaces (16 new route files):
- companies, contacts, calls, meetings, commissions, payouts
- disputes, guarantees, consents, complaints, knowledge
- sectors, presentations, supervisor, admin, health
- Updated router.py with all 24 route groups

Phase 4 - AI Prompt Registry (18 agent contracts):
- Lead Qualification, Affiliate Recruitment Evaluator, Onboarding Coach
- Outreach Writer, Arabic WhatsApp, English Conversation, Voice Call
- Meeting Booking, Sector Strategist, Objection Handler
- Proposal Drafter, QA Reviewer, Compliance Reviewer
- Knowledge Retrieval, Revenue Attribution, Fraud Reviewer
- Guarantee Claim Reviewer, Management Summary

Phase 5 - Communication Templates:
- 15 production templates (WhatsApp, email, voice, internal)
- Arabic + English variants with variable interpolation

Phase 6 - Compliance Center (7 legal docs):
- Privacy policy, Terms of service, Refund policy
- Commission policy, Affiliate rules, Consent policy, Data protection
- All PDPL-compliant, Arabic

Phase 7 - Celery Workers (fully implemented):
- follow_up_tasks: automated lead follow-ups with workflow execution
- message_tasks: WhatsApp/email/SMS with retry logic
- notification_tasks: daily reports, meeting reminders, in-app notifications
- affiliate_tasks: target checking, commission calculation, weekly reports, AI outreach

Phase 8 - Knowledge Base OS (8 files):
- Services overview, Pricing policy, Channel policy, Meeting policy
- Identity rules, Escalation rules, Hiring path, Internal SOPs

https://claude.ai/code/session_01KnJgK7RwyeCvRZTRThHtfU
2026-03-31 07:57:48 +00:00

42 lines
1.3 KiB
Markdown

# Contributing to Dealix
## Ground Rules
1. **No secrets.** Never commit `.env` files, API keys, private keys, certificates, or credentials.
2. **No `.env` files.** Use `.env.example` with placeholder values only.
3. **No key files.** Files matching `*.pem`, `*.key`, `*.crt`, `*.p12` must never be tracked.
4. **Small, auditable changes.** Each pull request should do one thing and be easy to review.
5. **Clear commit messages.** Use prefixed format:
- `fix:` - Bug fix
- `feat:` - New feature
- `docs:` - Documentation only
- `refactor:` - Code restructuring without behavior change
- `test:` - Adding or updating tests
- `chore:` - Tooling, CI, dependencies
6. **Branch from `main`.** Create a feature branch, open a PR back to `main`.
## Workflow
```
git checkout main
git pull origin main
git checkout -b feat/your-feature
# make changes
git add <specific files>
git commit -m "feat: describe your change"
git push origin feat/your-feature
# open a Pull Request
```
## What We Review
- No secrets or credentials in diff
- Scoped to a single concern
- Tests pass (if applicable)
- Consistent with existing code style
- No unnecessary files (logs, build artifacts, IDE configs)
## Questions
Open a discussion or contact the maintainer before starting large changes.