Skip to content

Commit

Permalink
change from policy to guidelines, add flexibility
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb committed Dec 12, 2024
1 parent da4527b commit 01c6977
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ versions approximately every 2 months.

[`object_store`]: https://crates.io/crates/object_store

### Deprecation Policy
### Deprecation Guidelines

Minor releases may deprecate, but not remove APIs. Deprecating APIs allows the
Rust programs to still compile, but will generate compiler warnings. This gives
downstream crates time to migrate to non deprecated APIs prior to their removal.
Minor releases may deprecate, but not remove APIs. Deprecating APIs allows
downstream Rust programs to still compile, but generate compiler warnings. This
gives downstream crates time to migrate prior to API removal.

All deprecated APIs are marked using the `#[deprecated]` attribute with both the
first version they were deprecated in, and what new API to use instead.
Expand All @@ -95,10 +95,12 @@ first version they were deprecated in, and what new API to use instead.
#[deprecated(since = "51.0.0", note = "Use `date_part` instead")]
```

Deprecated APIs will be kept for at least two major releases after they were
deprecated. For example, an API deprecated in `51.3.0` will not be removed until
at least `54.0.0`. Given the planned release schedule, this is typically between
6 and 9 months.
In general, deprecated APIs will be kept for at least two major releases after
they were deprecated (typically between 6 - 9 months later). For example, an API
deprecated in `51.3.0` can be removed in `54.0.0` (or later). Deprecated APIs
may be removed earlier or later than these guidelines at the discretion of the
maintainers.


## Related Projects

Expand Down

0 comments on commit 01c6977

Please sign in to comment.