Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (37 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.55 KB

Contributing to Cineweave

Thanks for contributing.

Scope

Cineweave is an open-source workflow platform with a BYOK-first provider integration model.

Contributions are welcome for:

  • workflow UX improvements
  • provider adapters
  • reliability and observability
  • docs and deployment examples
  • tests and bug fixes

Before You Start

  1. Read the README and deployment docs
  2. Confirm the change fits the current direction (open-source + BYOK)
  3. Prefer opening an issue before large feature work

Development Guidelines

  • Keep provider secrets out of source control
  • Add/extend tests where behavior changes
  • Preserve BYOK-first behavior (do not hardcode platform-managed credentials)
  • Prefer small, reviewable commits

Provider Adapter Contributions

If you contribute a new provider adapter:

  1. Implement the adapter in apps/api/src/providers/
  2. Document required environment variables in:
    • docs/providers/byok-setup.md
  3. Add error mapping for common provider failures (auth, quota, rate limit, invalid payload)
  4. Avoid embedding real credentials or tenant-specific URLs

Pull Requests

  • Use a clear title and describe behavior changes
  • Include screenshots for UI changes
  • Include sample request/response for API/provider integration changes
  • Mention any new env vars or deployment implications

Code Quality Expectations

We optimize for maintainability and production-grade behavior:

  • explicit error handling
  • actionable user-facing failures
  • consistent UI states (loading / empty / error / disabled reasons)
  • minimal hidden coupling