From 755f54f4d9b51885076f7aa31334389056361ea7 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Sun, 10 Oct 2021 08:35:29 -0600 Subject: [PATCH] Update CONTRIBUTING & remove pull request template --- .github/CONTRIBUTING.md | 29 +++++++++++++++-------------- .github/pull_request_template.md | 7 ------- README.md | 7 ++++--- 3 files changed, 19 insertions(+), 24 deletions(-) delete mode 100644 .github/pull_request_template.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 917b04a..b1cf452 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,17 +1,18 @@ -## Open-source, not open-contribution +## Contribution Policy -[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. +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. + +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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index fe28e01..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -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 diff --git a/README.md b/README.md index c25e978..68ac73c 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,10 @@ 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. -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. +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. If you find mistakes in the documentation, please submit a fix to the [documentation repository][docs].