Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add user-facing deprecation, release, and Python support policies #2726

Open
namurphy opened this issue Jun 20, 2024 · 0 comments
Open

Add user-facing deprecation, release, and Python support policies #2726

namurphy opened this issue Jun 20, 2024 · 0 comments
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org

Comments

@namurphy
Copy link
Member

Nature of improvement

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org
Projects
None yet
Development

No branches or pull requests

1 participant