Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (62 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 3.31 KB
Raw

Contributing to Vodou

Thanks for wanting to help. This repo (VodouAI/OS) is the open, Apache-2.0-licensed client surface of Vodou. A quick, honest map so your time goes where it counts.

What this repo is (and isn't)

Vodou is open-core — and the line is simple: everything except the engine is open.

  • ✅ Open (this repo, Apache-2.0): the entire client + orchestration stack — the gateway, all first-party MCP servers, the browser extension, the skill format, installers, and docs. All of it is fair game for contributions. Preserve the NOTICE file on redistribution.
  • 🔒 Proprietary (not here): the Vodou engine — its Rust source (src/**, Cargo.*) and its compiled binaries (vodou-core, vodou-hook-bin). The engine ships as a signed binary from VodouAI/vodou-core under its EULA. Its source isn't public, so PRs to the engine aren't possible — everything else is.

If you're unsure whether something is contributable, open an issue and ask first.

Good places to contribute

  • Browser-capture adapters for new AI surfaces
  • Client / extension fixes and UX
  • New or improved skills
  • Docs, examples, quickstart improvements
  • Bug reports with clear repro (see the issue templates)

Have a look at issues labeled good first issue to start.

Development setup

git clone https://github.com/VodouAI/OS
cd OS
# follow the README quickstart — the installer fetches the engine binary
./install-vodou.sh        # or the platform installer

Run the relevant tests before opening a PR (each component documents its own).

Branch model

main is the only long-lived branch for this public tree. It is protected and requires a signed CLA (CLAAssistant status check) before merge.

  • Community: fork → feature branch → PR into main. There is no public development branch here.
  • Maintainers: official drops are synced to main from Vodou's private monorepo via the publish script. Do not open long-lived staging branches on this repo — they drift from the real source of truth.
  • cla-signatures: internal store for CLA signature JSON only (not for code).

Pull requests

  1. Fork, branch off main, make focused changes (one concern per PR).
  2. Keep the diff minimal — match the surrounding code's style.
  3. Update docs if you change behavior.
  4. Sign the CLA — see below (required once per contributor).
  5. Open the PR against main; fill in the template.

We aim to review within a few working days.

Contributor License Agreement (CLA)

We use a lightweight CLA (not DCO). It lets you keep ownership of your work while granting Vodou the rights needed to use, distribute, and — if needed later — relicense the open surface. Full text: CLA.md (individuals) · CLA-CORPORATE.md (companies).

How to sign: on your first PR, the CLA Assistant bot will comment. Reply with:

I have read the CLA Document and I hereby sign the CLA

Entity-owned contributions: email legal@vodou.ai before merging (Corporate CLA).

Code of Conduct

By participating you agree to our Code of Conduct.

Security

Please do not file security issues publicly — see SECURITY.md for private disclosure.