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 a migration guide #371

Merged
merged 2 commits into from
Dec 13, 2024
Merged

Add a migration guide #371

merged 2 commits into from
Dec 13, 2024

Conversation

davidorme
Copy link
Collaborator

Description

This PR:

  • Updates CHANGES.md with new functionality in 2.0.0rc1
  • Adds a new users/versions.md page to the docs that:
    • Starts with migration notes from 1.0.0 to 2.0.0
    • Includes CHANGES.md, rendered into nice HTML.

Fixes #369

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@davidorme davidorme linked an issue Dec 12, 2024 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.26%. Comparing base (1f315ba) to head (6a7625d).
Report is 519 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #371      +/-   ##
===========================================
+ Coverage    95.29%   96.26%   +0.97%     
===========================================
  Files           28       34       +6     
  Lines         1720     2652     +932     
===========================================
+ Hits          1639     2553     +914     
- Misses          81       99      +18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@MarionBWeinzierl MarionBWeinzierl left a comment

Choose a reason for hiding this comment

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

Useful to add to the docs

@davidorme davidorme merged commit 8a20be1 into develop Dec 13, 2024
13 checks passed
@davidorme davidorme deleted the 369-add-a-migration-guide branch December 13, 2024 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add a migration guide from 1.0.0 to 2.0.0
3 participants