rkrtechnology/litestream
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update contribution policy

Browse Source
This commit is contained in:
Ben Johnson
2021-10-02 09:21:24 -06:00
parent 6db06067b5
commit aa2c684c81
1 changed files with 11 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -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!
## Open-source, not open-contribution
## Contribution Policy
[Similar to SQLite](https://www.sqlite.org/copyright.html), Litestream is open
source but closed to code contributions. This keeps the code base free of
proprietary or licensed code but it also helps me continue to maintain and build
Litestream.
Initially, Litestream was closed to outside contributions. The goal was to
reduce burnout by limiting the maintenance overhead of reviewing and validating
third-party code. However, this policy is overly broad and has prevented small,
easily testable patches from being contributed.
As the author of [BoltDB](https://github.com/boltdb/bolt), I found that
accepting and maintaining third party patches contributed to my burn out and
I eventually archived the project. Writing databases & low-level replication
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.
Litestream is now open to code contributions for bug fixes only. Features
carry a long-term maintenance burden so they will not be accepted at this
time. Please [submit an issue][new-issue] if you have a feature you'd like to request.
I am grateful for community involvement, bug reports, & feature requests. I do
not wish to come off as anything but welcoming, however, I've
made the decision to keep this project closed to contributions for my own
mental health and long term viability of the project.
If you find mistakes in the documentation, please submit a fix to the
[documentation repository][docs].
The [documentation repository][docs] is MIT licensed and pull requests are welcome there.
[releases]: https://github.com/benbjohnson/litestream/releases
[new-issue]: https://github.com/benbjohnson/litestream/issues/new
[docs]: https://github.com/benbjohnson/litestream.io