Skip to content

Commit c6f14ed

Browse files
committed
📚 Add compatibility policy to README.md
I saw a chart similar to this in ruby/openssl's README, and it seems like this is a relatively simple way to communicate our versioning. I would like to add a (slightly) more detailed deprecation/compatibility policy in a future PR.
1 parent 119f43a commit c6f14ed

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,31 @@ end
6060
imap.expunge
6161
```
6262

63+
## Compatibility and Maintenance Policy
64+
65+
`net-imap` is bundled with Ruby releases. As a [bundled gem], it can be
66+
uninstalled from a Ruby installation and must be declared in `Gemfile` when used
67+
with `bundler`. Each stable branch of `net-imap` will remain supported as long
68+
as it is included as a bundled gem in [supported Ruby branches].
69+
70+
| |Bundled with|Compatible with|First bundled release |Supported? |
71+
|-----|------------|---------------|-----------------------------|-------------|
72+
|0.5.x| _Ruby 3.4_ | Ruby 3.1+ |0.5.?, Ruby 3.4.0, 2024-12-25|features |
73+
|0.4.x| Ruby 3.3 | Ruby 2.7+ |0.4.9, Ruby 3.3.0, 2023-12-25|backports |
74+
|0.3.x| Ruby 3.2 | Ruby 2.6+ |0.3.4, Ruby 3.2.0, 2022-12-25|bugfixes only|
75+
|0.2.x| Ruby 3.1 | Ruby 2.5+/2.6+|0.2.2, Ruby 3.1.0, 2021-12-25|security only|
76+
|0.1.x| Ruby 3.0* | Ruby 2.5+ |0.1.1, Ruby 3.0.0, 2020-12-25|end of life |
77+
|_pre_| in stdlib | | Ruby 1.6.2, 2000-12-25|end of life |
78+
79+
Version 0.1.x was packaged as a [default gem] for Ruby 3.0, and can not be
80+
uninstalled from a Ruby 3.0 installation. Before being extracted into a gem,
81+
`net/imap` was only packaged as a part of Ruby's releases. The first stable
82+
release to include `net/imap` was ruby 1.6.2, on 2000-12-25.
83+
84+
[bundled gem]: https://docs.ruby-lang.org/en/master/standard_library_rdoc.html#label-Bundled+gems
85+
[default gem]: https://docs.ruby-lang.org/en/master/standard_library_rdoc.html
86+
[supported Ruby branches]: https://www.ruby-lang.org/en/downloads/branches/
87+
6388
## Development
6489

6590
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

0 commit comments

Comments
 (0)