diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..917b04a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,17 @@ +## Open-source, not open-contribution + +[Similar to SQLite](https://www.sqlite.org/copyright.html), Litestream is open +source but closed to contributions. This keeps the code base free of proprietary +or licensed code but it also helps me continue to maintain and build Litestream. + +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. + +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. diff --git a/README.md b/README.md index a5008dc..1c1627b 100644 --- a/README.md +++ b/README.md @@ -240,7 +240,7 @@ $ litestream restore -timestamp 2020-01-01T00:00:00Z /path/to/db ``` Point-in-time restores only have the resolution of the timestamp of the WAL file -itself. By default, litestream will start a new WAL file every minute so +itself. By default, Litestream will start a new WAL file every minute so point-in-time restores are only accurate to the minute. @@ -276,9 +276,9 @@ another process is allowed to checkpoint the WAL. ## Open-source, not open-contribution -[Similar to SQLite](https://www.sqlite.org/copyright.html), litestream is open +[Similar to SQLite](https://www.sqlite.org/copyright.html), Litestream is open source but closed to contributions. This keeps the code base free of proprietary -or licensed code but it also helps me continue to maintain and build litestream. +or licensed code but it also helps me continue to maintain and build Litestream. 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