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 compatibility with different versions of Open XDMoD. #20

Closed

Conversation

aaronweeden
Copy link

Description

This PR adds documentation to README.md that documents compatibility with different versions of Open XDMoD.

This PR should be merged after version 1.0.1 of xdmod-data is released.

Motivation and Context

Since Open XDMoD is versioned separately but concurrently with xdmod-data, as new versions of each are released, it will be important to document which versions are compatible with each other.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • CHANGELOG.md has been updated
  • The milestone is set correctly on the pull request
  • The appropriate labels have been added to the pull request
  • Running the automated tests (see docs/developing.md) produces no errors
  • Updates have been made to the xdmod-notebooks repository as necessary, and the notebooks all run successfully

@aaronweeden aaronweeden added the documentation Improvements or additions to documentation label Nov 27, 2023
@aaronweeden aaronweeden added this to the 1.0.1 milestone Nov 27, 2023
@aaronweeden aaronweeden marked this pull request as draft November 28, 2023 20:07
@aaronweeden
Copy link
Author

Abandoned in favor of #26

@aaronweeden aaronweeden closed this Jun 7, 2024
@aaronweeden aaronweeden deleted the xdmod-version-compatibility branch June 7, 2024 21:26
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant