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

Improvements to development environment / cycle #4126

Open
4 tasks
behackl opened this issue Jan 20, 2025 · 0 comments
Open
4 tasks

Improvements to development environment / cycle #4126

behackl opened this issue Jan 20, 2025 · 0 comments
Labels
maintenance refactoring, typos, removing clutter/dead code, and other code quality improvements needs discussion Things which needs to be discussed before implemented.

Comments

@behackl
Copy link
Member

behackl commented Jan 20, 2025

There are a bunch of things that would be nice to get done until the next release to ensure a smoother dev experience with less friction when it comes to the releases and the changelog.

  • Switch project management tool from poetry to uv. As we are now recommending our users to use uv for their installation, it only makes sense to change our dev environment as well.
  • Check that lower bounds for required versions are actually sufficient for our direct dependencies. All issues that are reported with the new release are effectively a consequence of this: we don't notice this in fresh environments, but if users install Manim to their existing environments, we might end up with some packages that formally satisfy our version bounds, but are effectively too old.
  • Release changelogs: to make editing them more straightforward, we could move them to GitHub. Advantage: the automatically generated ones are very nice, and could even be processed by a script to fix categorization + links to the docs. At the same time, producing links to the reference manual is way more convenient with the current Sphinx setup. We should discuss this some more. Ideally, it should be a matter of an hour or two to fully prepare a small / bugfix release.
  • Make sure that the release process is properly documented in our wiki, including pre- and postprocessing steps.
@behackl behackl added maintenance refactoring, typos, removing clutter/dead code, and other code quality improvements needs discussion Things which needs to be discussed before implemented. labels Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance refactoring, typos, removing clutter/dead code, and other code quality improvements needs discussion Things which needs to be discussed before implemented.
Projects
None yet
Development

No branches or pull requests

1 participant