Skip to content

Commit 0f4080a

Browse files
namurphyrocco8773StanczakDominik
authored
Add PLEP 8 on switching to calendar versioning (#39)
* Begin new PLEP on date-based versioning * Note on PLEP 5 that it's superseded * Add admonition that PLEP 5 has been superseded * Update PLEP 8 * Update index of PLEPs * Update README.rst * Remove point about switch being permanent * Apply suggestions from code review Co-authored-by: Erik Everson <[email protected]> * Apply suggestions from code review Co-authored-by: Erik Everson <[email protected]> * Apply suggestions from code review * Remove statement about zero-padded month Co-authored-by: Erik Everson <[email protected]> * Add missing word Co-authored-by: Dominik Stańczak-Marikin <[email protected]> * Add DOI to PLEP 8 * Update index of PLEPs * Update PLEP 8 and author list * Update PLEP 8 * Minor updates to PLEP 8 * Remove admonition * Remove admonition * Add link to DOI for PLEP 8 * Update PLEP 5 * Update PLEP authorship * Update date * Update DOI * Update formatting Co-authored-by: Erik Everson <[email protected]> Co-authored-by: Dominik Stańczak-Marikin <[email protected]>
1 parent 2d50a9d commit 0f4080a

File tree

4 files changed

+262
-57
lines changed

4 files changed

+262
-57
lines changed

‎PLEP-0000.rst

Lines changed: 94 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2,81 +2,120 @@
22
PLEP-0000 - Index of PlasmaPy Enhancement Proposals
33
=====================================================
44

5-
+-------------------+---------------------------------------------------------------------+
6-
| PLEP | 0 |
7-
+===================+=====================================================================+
8-
| author(s) | PlasmaPy Community |
9-
+-------------------+---------------------------------------------------------------------+
10-
| date created | 2017-09-28 |
11-
+-------------------+---------------------------------------------------------------------+
12-
| date last revised | 2018-09-26 |
13-
+-------------------+---------------------------------------------------------------------+
14-
| type | informational |
15-
+-------------------+---------------------------------------------------------------------+
16-
| DOI | `10.5281/zenodo.1435972 <https://doi.org/10.5281/zenodo.1435972>`__ |
17-
+-------------------+---------------------------------------------------------------------+
5+
+-------------------+---------------------------+
6+
| PLEP | 0 |
7+
+===================+===========================+
8+
| author(s) | PlasmaPy Community |
9+
+-------------------+---------------------------+
10+
| date created | 2017-09-28 |
11+
+-------------------+---------------------------+
12+
| date last revised | 2022-12-13 |
13+
+-------------------+---------------------------+
14+
| type | informational |
15+
+-------------------+---------------------------+
16+
| DOI | `10.5281/zenodo.1435972`_ |
17+
+-------------------+---------------------------+
1818

1919
This PLEP is an index of all PlasmaPy Enhancement Proposals, known as
2020
PLEPs (to avoid confusion with Python Enhancement Proposals, or PEPs).
2121

2222
Informational PLEPs
2323
===================
2424

25-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
26-
| number | title | author(s) | type | DOI |
27-
+========+===========================================================================+===========================+===============+=============================================+
28-
| 0 | `Index of PlasmaPy Enhancement Proposals | PlasmaPy Community | informational | `10.5281/zenodo.1435972 |
29-
| | <https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/master/PLEP-0000.rst>`__ | | | <https://doi.org/10.5281/zenodo.1435972>`__ |
30-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
31-
| 3 | `Members of Coordinating Committee | PlasmaPy Community | informational | `10.5281/zenodo.1435988 |
32-
| | <https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/master/PLEP-0003.rst>`__ | | | <https://doi.org/10.5281/zenodo.1435988>`__ |
33-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
25+
+--------+--------------------------------------------+--------------------+---------------+---------------------------+
26+
| number | title | author(s) | type | DOI |
27+
+========+============================================+====================+===============+===========================+
28+
| 0 | `Index of PlasmaPy Enhancement Proposals`_ | PlasmaPy Community | informational | `10.5281/zenodo.1435972`_ |
29+
+--------+--------------------------------------------+--------------------+---------------+---------------------------+
30+
| 3 | `Members of Coordinating Committee`_ | PlasmaPy Community | informational | `10.5281/zenodo.1435988`_ |
31+
+--------+--------------------------------------------+--------------------+---------------+---------------------------+
32+
33+
.. _Index of PlasmaPy Enhancement Proposals: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0000.rst
34+
.. _10.5281/zenodo.1435972: https://doi.org/10.5281/zenodo.1435972
35+
36+
.. _Members of Coordinating Committee: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0003.rst
37+
.. _10.5281/zenodo.1435988: https://doi.org/10.5281/zenodo.1435988
3438

3539
Accepted PLEPs
3640
==============
3741

38-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
39-
| number | title | author(s) | type | DOI |
40-
+========+===========================================================================+===========================+===============+=============================================+
41-
| 1 | `Purpose and Guidelines for PlasmaPy Enhancement Proposals | Nicholas A. Murphy | process | `10.5281/zenodo.1435976 |
42-
| | <https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/master/PLEP-0001.rst>`__ | | | <https://doi.org/10.5281/zenodo.1435976>`__ |
43-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
44-
| 2 | `PlasmaPy Governance | Nicholas A. Murphy | process | `10.5281/zenodo.1435980 |
45-
| | <https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/master/PLEP-0002.rst>`__ | | | <https://doi.org/10.5281/zenodo.1435980>`__ |
46-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
47-
| 4 | `Licensing of PlasmaPy Repositories | Nicholas A. Murphy | process | `10.5281/zenodo.1435990 |
48-
| | <https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/master/PLEP-0004.rst>`__ | | | <https://doi.org/10.5281/zenodo.1435990>`__ |
49-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
50-
| 5 | `PlasmaPy Versioning and Releases | Nicholas A. Murphy and | process | `10.5281/zenodo.1451974 |
51-
| | <https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/master/PLEP-0005.rst>`__ | Stuart J. Mumford | | <https://doi.org/10.5281/zenodo.1451974>`__ |
52-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
53-
| 6 | `A New General-Purpose Plasma Object | Andrew J. Leonard | standard | `10.5281/zenodo.1460976 |
54-
| | <https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/master/PLEP-0006.rst>`__ | | | <https://doi.org/10.5281/zenodo.1460976>`__ |
55-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
42+
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
43+
| number | title | author(s) | type | DOI |
44+
+========+==============================================================+======================+============+===========================+
45+
| 1 | `Purpose and Guidelines for PlasmaPy Enhancement Proposals`_ | Nicholas A. Murphy | process | `10.5281/zenodo.1435976`_ |
46+
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
47+
| 2 | `PlasmaPy Governance`_ | Nicholas A. Murphy | process | `10.5281/zenodo.1435980`_ |
48+
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
49+
| 4 | `Licensing of PlasmaPy Repositories`_ | Nicholas A. Murphy | process | `10.5281/zenodo.1435990`_ |
50+
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
51+
| 6 | `A New General-Purpose Plasma Object`_ | Andrew J. Leonard | standard | `10.5281/zenodo.1460976`_ |
52+
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
53+
| 7 | `Structure of Top-Level Sub-Packages`_ | Erik T. Everson, | standard | `10.5281/zenodo.3774573`_ |
54+
| | | Tulasi Parashar, | | |
55+
| | | Stephen Vincena, and | | |
56+
| | | Nicholas A. Murphy | | |
57+
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
58+
| 8 | `Calendar Versioning`_ | Nicholas A. Murphy, | process | `10.5281/zenodo.7434060`_ |
59+
| | | Erik T. Everson, and | | |
60+
| | | Dominik | | |
61+
| | | Stańczak-Marikin | | |
62+
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
63+
64+
.. _Purpose and Guidelines for PlasmaPy Enhancement Proposals: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0001.rst
65+
.. _10.5281/zenodo.1435976: https://doi.org/10.5281/zenodo.1435976
66+
67+
.. _PlasmaPy Governance: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0002.rst
68+
.. _10.5281/zenodo.1435980: https://doi.org/10.5281/zenodo.1435980
69+
70+
.. _Licensing of PlasmaPy Repositories: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0004.rst
71+
.. _10.5281/zenodo.1435990: https://doi.org/10.5281/zenodo.1435990
72+
73+
.. _A New General-Purpose Plasma Object: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0006.rst
74+
.. _10.5281/zenodo.1460976: https://doi.org/10.5281/zenodo.1460976
75+
76+
.. _Structure of Top-Level Sub-Packages: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0007.rst
77+
.. _10.5281/zenodo.3774573: https://doi.org/10.5281/zenodo.3774573
78+
79+
.. _10.5281/zenodo.7434060: https://doi.org/10.5281/zenodo.7434060
80+
.. _Calendar Versioning: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0008.rst
5681

5782
Declined PLEPs
5883
==============
5984

60-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
61-
| number | title | author(s) | type | DOI |
62-
+========+===========================================================================+===========================+===============+=============================================+
63-
| | | | | |
64-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+---------------------------------------------+
85+
+--------+-------------------------------------+------------------------+------------+---------------------------+
86+
| number | title | author(s) | type | DOI |
87+
+========+=====================================+========================+============+===========================+
88+
| | | | | |
89+
+--------+-------------------------------------+------------------------+------------+---------------------------+
90+
91+
92+
PLEPs that are no longer in effect
93+
==================================
94+
95+
+--------+-------------------------------------+------------------------+------------+---------------------------+
96+
| number | title | author(s) | type | DOI |
97+
+========+=====================================+========================+============+===========================+
98+
| 5 | `PlasmaPy Versioning and Releases`_ | Nicholas A. Murphy and | process | `10.5281/zenodo.1451974`_ |
99+
| | | Stuart J. Mumford | | |
100+
+--------+-------------------------------------+------------------------+------------+---------------------------+
101+
102+
.. _PlasmaPy Versioning and Releases: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0005.rst
103+
.. _10.5281/zenodo.1451974: https://doi.org/10.5281/zenodo.1451974
65104

66105
PLEPs in preparation or under consideration
67106
===========================================
68107

69-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+
70-
| number | title | author(s) | type |
71-
+========+===========================================================================+===========================+===============+
72-
| | | | |
73-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+
108+
+--------+-------------------------------------+------------------------+------------+---------------------------+
109+
| number | title | author(s) | type | DOI |
110+
+========+=====================================+========================+============+===========================+
111+
| | | | | |
112+
+--------+-------------------------------------+------------------------+------------+---------------------------+
74113

75114
Tentatively Reserved PLEPs
76115
==========================
77116

78-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+
79-
| number | title | author(s) | type |
80-
+========+===========================================================================+===========================+===============+
81-
| TBD | Data Structures | | standard |
82-
+--------+---------------------------------------------------------------------------+---------------------------+---------------+
117+
+--------+-------------------------------------+------------------------+------------+---------------------------+
118+
| number | title | author(s) | type | DOI |
119+
+========+=====================================+========================+============+===========================+
120+
| | | | | |
121+
+--------+-------------------------------------+------------------------+------------+---------------------------+

‎PLEP-0005.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,18 @@ PLEP-0005 – PlasmaPy Versioning and Releases
1212
+-------------------+---------------------------------------------+
1313
| date created | 2017-10-14 |
1414
+-------------------+---------------------------------------------+
15-
| date last revised | 2018-09-17 |
15+
| date last revised | 2023-01-11 |
1616
+-------------------+---------------------------------------------+
1717
| type | process |
1818
+-------------------+---------------------------------------------+
19-
| status | accepted |
19+
| status | superseded by `PLEP 8`_ |
2020
+-------------------+---------------------------------------------+
2121
| DOI | `10.5281/zenodo.1451974 |
2222
| | <https://doi.org/10.5281/zenodo.1451974>`__ |
2323
+-------------------+---------------------------------------------+
2424

25+
This PLEP has been superseded by `PLEP 8`_ and is no longer in effect.
26+
2527
Brief Description
2628
-----------------
2729

@@ -257,3 +259,5 @@ Semantic versioning is a well-defined versioning scheme that provides
257259
users with useful information about whether or not there were any
258260
backward incompatible changes. This scheme is well-suited to a core
259261
scientific software package that will require stability.
262+
263+
.. _PLEP 8: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0008.rst

0 commit comments

Comments
 (0)