1.9 KiB
Workflow
This document is there to help you recreate a working environment for Manim Slides.
Dependencies
:start-after: <!-- start deps -->
:end-before: <!-- end deps -->
Forking the repository and cloning it locally
We used GitHub to host Manim Slides' repository, and we encourage contributors to use git.
Useful links:
Once you feel comfortable with git and GitHub, fork the repository, and clone it locally.
As for every Python project, using virtual environment is recommended to avoid conflicts between modules. For Manim Slides, we use Poetry. If not already, please install it.
Installing Python modules
With Poetry, installation becomes straightforward:
poetry install
Running commands
As modules were installed in a new Python environment, you cannot use them directly in the shell.
Instead, you either need to prepend poetry run to any command, e.g.:
poetry run manim-slides wizard
or enter a new shell that uses this new Python environment:
poetry shell
manim-slides wizard
Testing your code
Most of the tests are done with GitHub actions, thus not on your computer. The only command you should run locally is pre-commit run --all-files: this runs a few linter and formatter to make sure the code quality and style stay constant across time. If a warning or an error is displayed, please fix it before going to next step.
Proposing changes
Once you feel ready and think your contribution is ready to be reviewed, create a pull request and wait for a reviewer to check your work!
Many thanks to you!