Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (76 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

104 lines (76 loc) · 3.81 KB

Contributing to IntendedOps

IntendedOps is open source under the Apache 2.0 license. Contributions are welcome.

Quick Start for Contributors

git clone https://github.com/intended-so/intendedops.git
cd intendedops
pnpm install
pnpm build
pnpm test

High-Value Contribution Areas

Domain Agents (Community Contribution Targets)

These domains have canonical intent types defined but need full agent implementations. Each is a great first contribution:

Domain Intent Types Reference
domains/identity/ provision_user, deprovision_user, rotate_credentials, enforce_mfa, initiate_access_review domains/billing/
domains/sales/ create_lead, update_pipeline, schedule_call, send_proposal, create_opportunity domains/support/
domains/contracts/ create_agreement, send_for_signature, generate_amendment, notify_expiration, archive_contract domains/billing/
domains/compliance/ check_control, record_evidence, generate_report, process_dsar, run_access_audit, update_risk_assessment domains/support/
domains/vendors/ onboard_vendor, assess_risk, request_document, offboard_vendor, create_vendor domains/billing/

Study domains/billing/src/agent.ts for a complete reference implementation. It shows:

  • Agent registration with trust tier requirements
  • Intent handler implementation
  • Adapter integration patterns
  • Audit event emission
  • Error handling and fail-closed behavior

Adapters

New adapter integrations are always welcome. Current adapters:

  • adapters/stripe/ — Stripe payment operations
  • adapters/zendesk/ — Zendesk support operations

Priority targets for new adapters:

  • Salesforce (CRM)
  • HubSpot (CRM)
  • Slack (notifications)
  • Okta (identity)
  • GitHub (engineering operations)
  • Notion (documentation)
  • Google Workspace (productivity)

Infrastructure Adapters

  • Database: MySQL adapter
  • Auth: Clerk adapter
  • AI: Ollama adapter
  • Payments: Paddle adapter
  • Storage: Google Cloud Storage adapter
  • Email: SendGrid adapter
  • Queue: Inngest adapter

Governance Principles (Non-Negotiable)

All contributions must respect IntendedOps' governance guarantees:

  1. No direct model-to-action execution. Every action proposed by an LLM must flow through the governance pipeline before execution.
  2. Fail-closed by default. When in doubt, block. Never silently allow.
  3. Governance cannot be bypassed. Contributions must not introduce paths that skip policy evaluation, trust checks, or audit recording.
  4. All actions emit outcomes. Every execution must produce an auditable outcome record.
  5. T3+ actions require human approval. High-impact actions must require explicit authorization.

Contributions that violate any of these principles will not be merged.

Development Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-contribution
  3. Make your changes
  4. Add tests for new functionality
  5. Run pnpm typecheck and pnpm test locally
  6. Commit with a clear message describing what and why
  7. Open a pull request against main

Code Style

  • TypeScript strict mode
  • Zod for all runtime validation
  • No any types without explicit justification
  • Tests required for new domain agents and adapters
  • Follow existing patterns in domains/billing/ and domains/support/

Reporting Issues

  • Bugs: Open a GitHub issue with a minimal reproduction
  • Security vulnerabilities: Email security@intended.so (do not open public issues)
  • Feature requests: Open a GitHub discussion first before opening an issue

License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 license.

Built by Intended, Inc. — Intent Verification Infrastructure for Autonomous Agents.