zenstruck / filesystem

Wrapper for league/flysystem with alternate API and added functionality.
MIT License
19 stars 3 forks source link

Document "Backward Compatibility Promise" #70

Closed kbond closed 2 years ago

kbond commented 2 years ago

Requires #64.

## Backward Compatibility Promise

This library follows [Symfony's BC Promise](https://symfony.com/doc/current/contributing/code/bc.html) with the following exceptions:
1. `Zenstruck/Filesystem` is considered _internal_ for _implementation_ and should not be implemented in user-land code. _This rule may change in the future once the API is considered stable._
2. `Zenstruck/Filesystem/Node` and interfaces in the `Zenstruck/Filesystem/Node/*` namespace should be considered _internal_ for implementation.