Update contribution policy
This commit is contained in:
29
README.md
29
README.md
@@ -41,27 +41,20 @@ energy into the project to help make it better:
|
|||||||
Huge thanks to fly.io for their support and for contributing credits for testing and development!
|
Huge thanks to fly.io for their support and for contributing credits for testing and development!
|
||||||
|
|
||||||
|
|
||||||
## Open-source, not open-contribution
|
## Contribution Policy
|
||||||
|
|
||||||
[Similar to SQLite](https://www.sqlite.org/copyright.html), Litestream is open
|
Initially, Litestream was closed to outside contributions. The goal was to
|
||||||
source but closed to code contributions. This keeps the code base free of
|
reduce burnout by limiting the maintenance overhead of reviewing and validating
|
||||||
proprietary or licensed code but it also helps me continue to maintain and build
|
third-party code. However, this policy is overly broad and has prevented small,
|
||||||
Litestream.
|
easily testable patches from being contributed.
|
||||||
|
|
||||||
As the author of [BoltDB](https://github.com/boltdb/bolt), I found that
|
Litestream is now open to code contributions for bug fixes only. Features
|
||||||
accepting and maintaining third party patches contributed to my burn out and
|
carry a long-term maintenance burden so they will not be accepted at this
|
||||||
I eventually archived the project. Writing databases & low-level replication
|
time. Please [submit an issue][new-issue] if you have a feature you'd like to request.
|
||||||
tools involves nuance and simple one line changes can have profound and
|
|
||||||
unexpected changes in correctness and performance. Small contributions
|
|
||||||
typically required hours of my time to properly test and validate them.
|
|
||||||
|
|
||||||
I am grateful for community involvement, bug reports, & feature requests. I do
|
If you find mistakes in the documentation, please submit a fix to the
|
||||||
not wish to come off as anything but welcoming, however, I've
|
[documentation repository][docs].
|
||||||
made the decision to keep this project closed to contributions for my own
|
|
||||||
mental health and long term viability of the project.
|
|
||||||
|
|
||||||
The [documentation repository][docs] is MIT licensed and pull requests are welcome there.
|
[new-issue]: https://github.com/benbjohnson/litestream/issues/new
|
||||||
|
|
||||||
[releases]: https://github.com/benbjohnson/litestream/releases
|
|
||||||
[docs]: https://github.com/benbjohnson/litestream.io
|
[docs]: https://github.com/benbjohnson/litestream.io
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user