Skip to content

Commit a1f3207

Browse files
authored
Added a contributing.md (#1158)
Added a contributing.md
1 parent 13b8669 commit a1f3207

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Crucible project status and open source
2+
3+
The Crucible repo is public because it has always been our intention to
4+
make this open-source. We thought it was important to explain where we're
5+
currently at, and manage your expectations.
6+
7+
- We are a small company.
8+
9+
- Our current goal is support our first generation products.
10+
11+
- We're writing Crucible in support of that goal, not as its own thing. We're
12+
all working on the products, and block storage is an important product
13+
feature.
14+
15+
- Crucible itself has dependencies on many other Oxide repositories, which
16+
themselves are undergoing a similar development churn.
17+
18+
- These points together mean that we may not have enough bandwidth to review
19+
and integrate outside PRs right now. We hope this will change in the future.
20+
21+
You're welcome to send PRs, but we want to set expectations right: if we have
22+
time, or if the PRs are very small or fix bugs, we may integrate them in the
23+
near future. But we might also not get to any PR for a while, by which time it
24+
might no longer be relevant.
25+
26+
We've all dealt with those open source projects that feel open in name only, and
27+
have big patches and history-free source drops appearing from behind the walls
28+
of some large organization. We don't like that, and we're not going to do that.
29+
But it will take some time for us to scale up -- please bear with us.
30+
31+
If you want to ask about whether a PR is consistent with our short-term plan
32+
_before_ you put in the work -- and you should! -- hit us up on the repo
33+
Discussions tab on GitHub.
34+
35+
Thanks!

0 commit comments

Comments
 (0)