From ecae97a3cd86e7e6a366a3bac7332e1ed2dab169 Mon Sep 17 00:00:00 2001
From: nick evans <nick@rubinick.dev>
Date: Thu, 2 May 2024 09:29:29 -0400
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Add=20compatibility=20policy=20t?=
 =?UTF-8?q?o=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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'll propose documentation for a slightly more detailed policy in a
future PR.
---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 42610b3b1..6a28c7271 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,31 @@ end
 imap.expunge
 ```
 
+## Compatibility and 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 stable branch of `net-imap` will remain supported as long
+as it is included as a bundled gem in [supported Ruby branches].
+
+|     |Bundled with|Compatible with|First bundled release        |Supported?    |
+|-----|------------|---------------|-----------------------------|--------------|
+|0.5.x| _Ruby 3.4_ | Ruby 3.1+     |0.5.?, Ruby 3.4.0, 2024-12-25|new features  |
+|0.4.x| Ruby 3.3   | Ruby 2.7.3+   |0.4.9, Ruby 3.3.0, 2023-12-25|some backports|
+|0.3.x| Ruby 3.2   | Ruby 2.6+     |0.3.4, Ruby 3.2.0, 2022-12-25|bugfixes only |
+|0.2.x| Ruby 3.1   | Ruby 2.5+/2.6+|0.2.2, Ruby 3.1.0, 2021-12-25|security only |
+|0.1.x| Ruby 3.0*  | Ruby 2.5+     |0.1.1, Ruby 3.0.0, 2020-12-25|end of life   |
+|_pre_| in stdlib  |               |       Ruby 1.6.2, 2000-12-25|end of life   |
+
+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.