From a7082a8a4f508472bfa9eca62db462557ddfd967 Mon Sep 17 00:00:00 2001 From: Nick Murphy Date: Tue, 24 Jan 2023 15:04:13 -0500 Subject: [PATCH 1/3] Add PLEP 9 --- PLEP-0009.rst | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 PLEP-0009.rst diff --git a/PLEP-0009.rst b/PLEP-0009.rst new file mode 100644 index 0000000..51d01a6 --- /dev/null +++ b/PLEP-0009.rst @@ -0,0 +1,97 @@ +========================================================= +PLEP-0008 – Release schedule and long-term support policy +========================================================= + ++-------------------+---------------------------------------------+ +| PLEP | number | ++===================+=============================================+ +| author(s) | Nicholas A. Murphy | ++-------------------+---------------------------------------------+ +| contact email | namurphy@cfa.harvard.edu | ++-------------------+---------------------------------------------+ +| date created | *YYYY-MM-DD* | ++-------------------+---------------------------------------------+ +| date last revised | *YYYY-MM-DD* | ++-------------------+---------------------------------------------+ +| type | process | ++-------------------+---------------------------------------------+ +| status | discussion | ++-------------------+---------------------------------------------+ +| DOI | | +| | | ++-------------------+---------------------------------------------+ + +Abstract +======== + +This PLEP describes the nominal release schedule and long-term support +(LTS) policy for PlasmaPy. + +Detailed Description +==================== + +Release schedule +---------------- + +Feature releases of PlasmaPy will be scheduled for January, May, and +September of each year, and maintained with backwards compatible bug +fixes and documentation improvements until the next feature release. + +Python support policy +--------------------- + +For consistency with NumPy Enhancement Proposal 29, each feature +release will be compatible with minor versions of Python released in +the prior 42 months and minor versions of NumPy released in the prior +24 months. Because Python minor releases occur each October, the May +release of PlasmaPy will drop support of the oldest-supported version +of Python. For example, the May 2025 release of Python will drop +compatibility with Python 3.10 and require Python 3.11 or newer. + +Long-term support policy +------------------------ + +If there is sufficient funding for the development and maintenance of +PlasmaPy, then the first release in even-numbered years will be an LTS +release that will be maintained with bugfixes and documentation +improvements for two years. + +Implementation +============== + +To implement this PLEP, it will be necessary to implement +infrastructure for performing backports for LTS releases. For example, +when a pull request for Astropy is labeled as appropriate for a +backport, then a GitHub tool will automatically create a pull request +to the appropriate branches. This infrastructure will reduce the +effort needed to perform backports and minor releases. + +Alternatives +============ + +Feature release cadence +----------------------- + +This PLEP specifies a feature release cadence of four months. + +* A less frequent release schedule would reduce the amount of effort + by developers, but would delay new features being made available to + new users. Too much time between releases would also increase the + risk that developers would forget how to perform the releases. + +* A more frequent release schedule would enable features to become + available to users more quickly, but with the tradeoffs of + additional work overhead for each release, less stability for + users, and more difficulty keeping track of citations. + +A release cadence of four months balances these tradeoffs. + +Decision Rationale +================== + +*Summarize the discussion on this PLEP and describe the reasoning +behind the decision, if necessary.* + +*Not all PLEPs require all of these sections, and occasionally +additional sections may be necessary. Emphasized text should be +deleted.* From 141cee1c1bdb55b7dde5a39b952411f828f3f703 Mon Sep 17 00:00:00 2001 From: Nick Murphy Date: Tue, 24 Jan 2023 15:05:03 -0500 Subject: [PATCH 2/3] Add draft of PLEP on release schedule & LTS policy --- PLEP-0009.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLEP-0009.rst b/PLEP-0009.rst index 51d01a6..b9d5f22 100644 --- a/PLEP-0009.rst +++ b/PLEP-0009.rst @@ -1,5 +1,5 @@ ========================================================= -PLEP-0008 – Release schedule and long-term support policy +PLEP-0009 – Release schedule and long-term support policy ========================================================= +-------------------+---------------------------------------------+ From f3965b08a803550805af30a9bb9d933629737b0f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 24 Jan 2023 20:26:41 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- PLEP-0009.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLEP-0009.rst b/PLEP-0009.rst index b9d5f22..5e1d71f 100644 --- a/PLEP-0009.rst +++ b/PLEP-0009.rst @@ -25,7 +25,7 @@ Abstract ======== This PLEP describes the nominal release schedule and long-term support -(LTS) policy for PlasmaPy. +(LTS) policy for PlasmaPy. Detailed Description ==================== @@ -82,7 +82,7 @@ This PLEP specifies a feature release cadence of four months. * A more frequent release schedule would enable features to become available to users more quickly, but with the tradeoffs of additional work overhead for each release, less stability for - users, and more difficulty keeping track of citations. + users, and more difficulty keeping track of citations. A release cadence of four months balances these tradeoffs.