Skip to content

Commit

Permalink
📚 Add maintenance policy to README.md
Browse files Browse the repository at this point in the history
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 basic versioning
scheme.  Documentation for a more detailed backward compatibility policy
may be added in a future PR.
  • Loading branch information
nevans committed Oct 30, 2024
1 parent 5a0e5cb commit 0ba95f7
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,37 @@ end
imap.expunge
```

## Maintenance Policy

`net-imap` is bundled with Ruby releases. As a [bundled gem], it can be
uninstalled from a Ruby installation and must be declared in `Gemfile` when used
with `bundler`. Each Ruby `major.minor` release series bundles a specific
`net-imap` release series. Each `net-imap` release series will remain
compatible with at least two older versions of Ruby.

Each `net-imap` release series will receive security updates as long as they are
bundled with [supported Ruby branches]. The `net-imap` release series bundled
with Ruby's latest stable Ruby release series _may_ also receive backported
bugfixes and features, at the maintainers' discretion.

| |Bundled with|First bundled release |Minimum Ruby|Maintenance |End of life |
|-----|------------|-----------------------------|------------|--------------|------------|
|0.5.x| _not yet_ | _not bundled with Ruby yet_ |Ruby 3.1 |new features | |
|0.4.x| Ruby 3.3 |0.4.9, Ruby 3.3.0, 2023-12-25|Ruby 2.7.3 |some backports|_2027-03-31_|
|0.3.x| Ruby 3.2 |0.3.4, Ruby 3.2.0, 2022-12-25|Ruby 2.6 |security only |_2026-03-31_|
|0.2.x| Ruby 3.1 |0.2.2, Ruby 3.1.0, 2021-12-25|Ruby 2.5/2.6|security only |_2025-03-31_|
|0.1.x| Ruby 3.0* |0.1.1, Ruby 3.0.0, 2020-12-25|Ruby 2.5 |end of life | 2024-04-23 |
| | in stdlib | Ruby 1.6.2, 2000-12-25| |end of life | 2023-03-31 |

Version 0.1.x was packaged as a [default gem] for Ruby 3.0, and can not be
uninstalled from a Ruby 3.0 installation. Before being extracted into a gem,
`net/imap` was only packaged as a part of Ruby's releases. The first stable
release to include `net/imap` was ruby 1.6.2, on 2000-12-25.

[bundled gem]: https://docs.ruby-lang.org/en/master/standard_library_rdoc.html#label-Bundled+gems
[default gem]: https://docs.ruby-lang.org/en/master/standard_library_rdoc.html
[supported Ruby branches]: https://www.ruby-lang.org/en/downloads/branches/

## Development

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.
Expand Down

0 comments on commit 0ba95f7

Please sign in to comment.