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

Document the support policy for optional packages #3616

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

seisman
Copy link
Member

@seisman seisman commented Nov 13, 2024

doc/minversions.md Outdated Show resolved Hide resolved
Comment on lines +29 to +30
- Drop support for GMT versions 3 years after their initial release, while ensuring at
least two latest minor versions remain supported.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ensuring at least two latest minor versions remain supported.

I've added this sentence to the GMT support policy.

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also debating on whether to add something based on this note from SPEC 0:

Core packages may or may not decide to provide bug fix releases during the full 2 year period after release. Therefore, projects may occasionally want to drop support for core package dependencies earlier than recommended by this SPEC. For instance, if a newer minimum version of a core package is needed by a project due to a critical bug fix, which is not backported to older versions.

E.g. we have pinned to xarray>=2023.04 at #3460 earlier than expected.

doc/minversions.md Outdated Show resolved Hide resolved
doc/minversions.md Outdated Show resolved Hide resolved
doc/minversions.md Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <[email protected]>
@seisman
Copy link
Member Author

seisman commented Nov 13, 2024

Also debating on whether to add something based on this note from SPEC 0:

Core packages may or may not decide to provide bug fix releases during the full 2 year period after release. Therefore, projects may occasionally want to drop support for core package dependencies earlier than recommended by this SPEC. For instance, if a newer minimum version of a core package is needed by a project due to a critical bug fix, which is not backported to older versions.

E.g. we have pinned to xarray>=2023.04 at #3460 earlier than expected.

Maybe add a note like:

The policy is not strictly enforced and occasional breaches of the policy are allowed after discussions within the PyGMT team.

@seisman seisman added documentation Improvements or additions to documentation needs review This PR has higher priority and needs review. labels Nov 14, 2024
@seisman seisman added this to the 0.14.0 milestone Nov 14, 2024
@seisman seisman marked this pull request as ready for review November 14, 2024 02:07
doc/minversions.md Outdated Show resolved Hide resolved
doc/minversions.md Outdated Show resolved Hide resolved
@weiji14 weiji14 added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation final review call This PR requires final review and approval from a second reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support policy for optional dependencies (contextily, geopandas, rioxarray, etc)
3 participants