-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a contributing.md
- Loading branch information
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |