Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.66 KB

Omicron project status and open source

The Omicron repo is public because:

  1. It has always been our intention to make this open-source.
  2. We figured it's best to err on the side of doing this early instead of late.

However, Omicron is not done, or even ready.

And so, we thought it was important to explain where we're currently at, and manage your expectations.

  • We are a small company.

  • Our current goal is to get our first generation products finished and in customers' hands.

  • We're writing Omicron in support of that goal, not as its own thing. We're all working on the products, and tool development is a side effect.

  • Omicron itself has dependencies on many other Oxide repositories, which themselves are undergoing a similar development churn.

  • These points together mean that we may not have enough bandwidth to review and integrate outside PRs right now. We hope this will change in the future.

You're welcome to send PRs, but we want to set expectations right: if we have time, or if the PRs are very small or fix bugs, we may integrate them in the near future. But we might also not get to any PR for a while, by which time it might no longer be relevant.

We've all dealt with those open source projects that feel open in name only, and have big patches and history-free source drops appearing from behind the walls of some large organization. We don't like that, and we're not going to do that. But it will take some time for us to scale up -- please bear with us.

If you want to ask about whether a PR is consistent with our short-term plan before you put in the work -- and you should! -- hit us up on the repo Discussions tab on GitHub.

Thanks!