Project and Licensing

How do I contribute to Traverse?

Traverse is open source and welcomes contributions. The main repository is at github.com/traverse-framework/traverse. Whether you fix a bug, improve a doc, or build a new placement target adapter, contributions move the project forward.

Good first contributions

  • Bug reports with a minimal reproduction case
  • Documentation improvements — clearer explanations, corrected examples
  • New capability examples that show real-world use cases
  • Test coverage for edge cases in the contract validation logic
  • Translations or localization of docs

Larger contributions

Before building something substantial — a new placement target adapter, a significant API change, a new crate — open a GitHub issue or discussion first. Describe what you want to build and why. This avoids wasted work if the direction does not align with the project's design goals.

The pull request process

  • Fork the repository and create a branch for your change
  • Make sure existing tests pass: cargo test --workspace
  • Add tests for new behavior
  • Keep commits focused — one logical change per commit
  • Open a pull request with a clear description of what changes and why

What Traverse needs most

The highest-value contributions right now are placement target adapters (browser, edge, cloud), real-world capability examples in industries like fintech and SaaS, and feedback from people using Traverse in production. If you are building something with Traverse, sharing what is working and what is not is itself a valuable contribution.