Please sign in to comment.
fix: deprecate geoips provider (#972)
* fix: deprecate geoips provider - adds `@deprecated` annotations to the class & constructor (which will warn people using IDEs) - Updates the readme and changelog to communicate the deprecation - Removes it from the main readme. * feat: add deprecation docs * fix: add back authors
- Loading branch information...
Showing with 32 additions and 4 deletions.
|@@ -0,0 +1,5 @@|
|Procedures for Geocoder contributors.|
|- [Provider Deprecation](provider-deprecation.md)|
|@@ -0,0 +1,12 @@|
|# Deprecating providers|
|A provider is considered shut down when the APIs no longer respond to queries with a valid geocoded response.|
|If the provider has alternatives that are a drop in replacement, or offer self hosting it should not be deprecated.|
|1) Update Provider class, adding `@deprecated` annotations to the class and constructor method.|
|2) Remove the provider from the main repository README|
|3) Update the provider README to indicate that the package is abandoned, and where possible include alternatives.|
|4) Publish new package version (containing the `@deprecated` annotations) to Packagist|
|5) Mark Packagist package as abandoned|