README (#466)
This commit is contained in:
29
.github/CONTRIBUTING.md
vendored
29
.github/CONTRIBUTING.md
vendored
@@ -1,17 +1,18 @@
|
|||||||
## 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 contributions. This keeps the code base free of proprietary
|
reduce burnout by limiting the maintenance overhead of reviewing and validating
|
||||||
or licensed code but it also helps me continue to maintain and build Litestream.
|
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
|
Litestream is now open to code contributions for bug fixes only. Features carry
|
||||||
accepting and maintaining third party patches contributed to my burn out and
|
a long-term maintenance burden so they will not be accepted at this time.
|
||||||
I eventually archived the project. Writing databases & low-level replication
|
Please [submit an issue][new-issue] if you have a feature you'd like to
|
||||||
tools involves nuance and simple one line changes can have profound and
|
request.
|
||||||
unexpected changes in correctness and performance. Small contributions
|
|
||||||
typically required hours of my time to properly test and validate them.
|
If you find mistakes in the documentation, please submit a fix to the
|
||||||
|
[documentation repository][docs].
|
||||||
|
|
||||||
|
[new-issue]: https://github.com/benbjohnson/litestream/issues/new
|
||||||
|
[docs]: https://github.com/benbjohnson/litestream.io
|
||||||
|
|
||||||
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.
|
|
||||||
|
|||||||
7
.github/pull_request_template.md
vendored
7
.github/pull_request_template.md
vendored
@@ -1,7 +0,0 @@
|
|||||||
Litestream is not accepting code contributions at this time. You can find a summary of why on the project's GitHub README:
|
|
||||||
|
|
||||||
https://github.com/benbjohnson/litestream#open-source-not-open-contribution
|
|
||||||
|
|
||||||
Web site & Documentation changes, however, are welcome. You can find that repository here:
|
|
||||||
|
|
||||||
https://github.com/benbjohnson/litestream.io
|
|
||||||
38
README.md
38
README.md
@@ -33,35 +33,29 @@ energy into the project to help make it better:
|
|||||||
|
|
||||||
- Thanks to [Cory LaNou](https://twitter.com/corylanou) for giving early feedback and testing when Litestream was still pre-release.
|
- Thanks to [Cory LaNou](https://twitter.com/corylanou) for giving early feedback and testing when Litestream was still pre-release.
|
||||||
- Thanks to [Michael Lynch](https://github.com/mtlynch) for digging into issues and contributing to the documentation.
|
- Thanks to [Michael Lynch](https://github.com/mtlynch) for digging into issues and contributing to the documentation.
|
||||||
- Thanks to [Kurt Mackey](https://twitter.com/mrkurt) for feedback and testing. Also, thanks to fly.io for providing testing resources.
|
- Thanks to [Kurt Mackey](https://twitter.com/mrkurt) for feedback and testing.
|
||||||
- Thanks to [Sam Weston](https://twitter.com/cablespaghetti) for figuring out how to run Litestream on Kubernetes and writing up the docs for it.
|
- Thanks to [Sam Weston](https://twitter.com/cablespaghetti) for figuring out how to run Litestream on Kubernetes and writing up the docs for it.
|
||||||
- Thanks to [Rafael](https://github.com/netstx) & [Jungle Boogie](https://github.com/jungle-boogie) for helping to get OpenBSD release builds working.
|
- Thanks to [Rafael](https://github.com/netstx) & [Jungle Boogie](https://github.com/jungle-boogie) for helping to get OpenBSD release builds working.
|
||||||
- Thanks to [Simon Gottschlag](https://github.com/simongottschlag), [Marin](https://github.com/supermarin),[Victor Björklund](https://github.com/victorbjorklund), [Jonathan Beri](https://twitter.com/beriberikix) [Yuri](https://github.com/yurivish), [Nathan Probst](https://github.com/nprbst), [Yann Coleuu](https://github.com/yanc0), and [Nicholas Grilly](https://twitter.com/ngrilly) for frequent feedback, testing, & support.
|
- Thanks to [Simon Gottschlag](https://github.com/simongottschlag), [Marin](https://github.com/supermarin),[Victor Björklund](https://github.com/victorbjorklund), [Jonathan Beri](https://twitter.com/beriberikix) [Yuri](https://github.com/yurivish), [Nathan Probst](https://github.com/nprbst), [Yann Coleu](https://github.com/yanc0), and [Nicholas Grilly](https://twitter.com/ngrilly) for frequent feedback, testing, & support.
|
||||||
|
|
||||||
|
Huge thanks to fly.io for their support and for contributing credits for testing and development!
|
||||||
|
|
||||||
|
|
||||||
|
## Contribution Policy
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
## Open-source, not open-contribution
|
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.
|
||||||
|
|
||||||
[Similar to SQLite](https://www.sqlite.org/copyright.html), Litestream is open
|
If you find mistakes in the documentation, please submit a fix to the
|
||||||
source but closed to code contributions. This keeps the code base free of
|
[documentation repository][docs].
|
||||||
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
|
[new-issue]: https://github.com/benbjohnson/litestream/issues/new
|
||||||
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.
|
|
||||||
|
|
||||||
The [documentation repository][docs] is MIT licensed and pull requests are welcome there.
|
|
||||||
|
|
||||||
[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