You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would be helpful for our documentation to describe:
Our versioning policy
Date-based versioning (including a link to the relevant PlasmaPy Enhancement Proposal)
Release practices
A few minor releases per year (though this may depend on availability of funding)
Python and package support policies
Support versions of Python released in last three years
Support for newest Python may take a few months
How deprecation of functionality is handled
Adding deprecation warnings for at least two releases or six months before removal?
Mention that if user code is made openly available on GitHub or GitLab, we can do code searches to see if any deprecations or removals would have a major impact.
Recommend that people depending on PlasmaPy perform tests in CI against the GitHub repository (though we should probably do monthly beta releases; Automate monthly beta releases #1786)
This should be a pretty high-level discussion that is intended for users and not core PlasmaPy contributors. It'd help to avoid adding information that is likely to change significantly over time.
Location of improvement
I'm thinking that this could go in the "all the rest" section of the documentation sidebar, maybe listed just after the changelog.
Additional context
Inspired by our friends from the heliopythoniverse at sunpy/sunpy#7661!
The text was updated successfully, but these errors were encountered:
Nature of improvement
It would be helpful for our documentation to describe:
This should be a pretty high-level discussion that is intended for users and not core PlasmaPy contributors. It'd help to avoid adding information that is likely to change significantly over time.
Location of improvement
I'm thinking that this could go in the "all the rest" section of the documentation sidebar, maybe listed just after the changelog.
Additional context
Inspired by our friends from the heliopythoniverse at sunpy/sunpy#7661!
The text was updated successfully, but these errors were encountered: