Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a contributing.md #1158

Merged
merged 2 commits into from
Feb 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Crucible project status and open source

The Crucible repo is public because it has always been our intention to
make this open-source. 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 support our first generation products.

- We're writing Crucible in support of that goal, not as its own thing. We're
all working on the products, and block storage is an important product
feature.

- Crucible 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!
Loading