Update CONTRIBUTING & remove pull request template
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
|
|
||||||
@@ -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,
|
third-party code. However, this policy is overly broad and has prevented small,
|
||||||
easily testable patches from being contributed.
|
easily testable patches from being contributed.
|
||||||
|
|
||||||
Litestream is now open to code contributions for bug fixes only. Features
|
Litestream is now open to code contributions for bug fixes only. Features carry
|
||||||
carry a long-term maintenance burden so they will not be accepted at this
|
a long-term maintenance burden so they will not be accepted at this time.
|
||||||
time. Please [submit an issue][new-issue] if you have a feature you'd like to request.
|
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
|
If you find mistakes in the documentation, please submit a fix to the
|
||||||
[documentation repository][docs].
|
[documentation repository][docs].
|
||||||
|
|||||||
Reference in New Issue
Block a user