Skip to content

Commit 22c9073

Browse files
authored
Lim edits
1 parent 5c1adcc commit 22c9073

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

APE_LTS.rst renamed to APE21.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: Thomas Robitaille, Pey Lian Lim, Simon Conseil
55

66
date-created: 2023 February 16
77

8-
date-last-revised: 2023 February 20 <keep this up to date anytime something changes>
8+
date-last-revised: 2023 February 21 <keep this up to date anytime something changes>
99

1010
date-accepted: <replace with accepted date>
1111

@@ -18,7 +18,7 @@ Abstract
1818
--------
1919

2020
This APE proposes to no longer designate any releases of the core package as being
21-
'long term support' (LTS) and provide guidance on how to handle API changes and deprecations.
21+
"long-term support" (LTS) and provide guidance on how to handle API changes and deprecations.
2222

2323

2424
Detailed description
@@ -27,15 +27,15 @@ Detailed description
2727
`APE 2: Astropy Release Cycle and Version Numbering <https://doi.org/10.5281/zenodo.1043887>`_ describes the release cycle
2828
for the core astropy package, which consists of major releases every 6 months that
2929
add new features (e.g., v5.2), and releases in between this that are limited to fixing bugs
30-
or updating documentation (e.g., v5.2.1). Every two years, major releases are designated
30+
or updating documentation (e.g., v5.2.1). Every 2 years, major releases are designated
3131
as being LTS (e.g., v5.0) and we have committed to releasing bugfix releases
32-
for this version (e.g., v5.0.3) for up to two years.
32+
for this version (e.g., v5.0.3) for up to 2 years.
3333

3434
At the start of the project, having LTS releases was critical for acceptance by
3535
large organizations/projects for which stability is paramount, as the core package went through
3636
significant API changes from version to version due to the youth of the project and LTS
3737
releases were a way to shield against these changes, or at least reduce disruption to
38-
be every two years.
38+
be every 2 years.
3939

4040
LTS releases are however not free:
4141

@@ -58,10 +58,10 @@ in astropy either.
5858
This APE proposes the following:
5959

6060
* No longer designate any releases as LTS.
61-
* Keep the 6-month release cycle and bump releases to x.0 every two years.
62-
* Refer to the x.0 releases every two years (e.g., v6.0) as 'major'
63-
releases, other releases every 6 months (e.g., v6.1) as 'minor', and bug fixing
64-
releases (e.g., v6.1.2) as 'bugfix releases'.
61+
* Keep the 6-month release cycle and bump releases to x.0 every 2 years.
62+
* Refer to the x.0 releases every 2 years (e.g., v6.0) as "major"
63+
releases, other releases every 6 months (e.g., v6.1) as "minor", and bug fixing
64+
releases (e.g., v6.1.2) as "bugfix" releases.
6565
* Minimize as much as possible any changes that break API or change results in
6666
minor releases, but being pragmatic and accepting such changes if they would
6767
not affect many users.
@@ -71,7 +71,7 @@ This APE proposes the following:
7171
are deemed to be high impact enough to wait longer).
7272

7373
With this in place, we would effectively be striving to maximize stability over
74-
two year periods but users would see deprecation warnings to prepare them for
74+
two-year periods but users would see deprecation warnings to prepare them for
7575
changes. This is in contrast to the current LTS system where users might not see
7676
a deprecation warning until the next LTS release as deprecations are not typically
7777
backported.
@@ -91,9 +91,11 @@ Backward compatibility
9191
----------------------
9292

9393
N/A
94+
9495
Alternatives
9596
------------
9697

98+
<Remove placeholder below before merge>
9799
If there were any alternative solutions to solving the same problem, they should
98100
be discussed here, along with a justification for the chosen approach.
99101

0 commit comments

Comments
 (0)