mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
48 lines
1.8 KiB
ReStructuredText
48 lines
1.8 KiB
ReStructuredText
############
|
|
Contributing
|
|
############
|
|
|
|
.. important:: Manim is currently undergoing a major refactor. In general,
|
|
contributions implementing new features will not be accepted in this period.
|
|
Other contributions unrelated to cleaning up the codebase may also take a longer
|
|
period of time to be reviewed. This guide may quickly become outdated quickly; we
|
|
highly recommend joining our `Discord server <https://www.manim.community/discord/>`_
|
|
to discuss any potential contributions and keep up to date with the latest developments.
|
|
|
|
Thank you for your interest in contributing to Manim! However you have decided to contribute
|
|
or interact with the community, please always be civil and respect other
|
|
members of the community. If you haven't read our :doc:`code of conduct<conduct>`,
|
|
do so here. Manim is Free and Open Source Software (FOSS) for mathematical
|
|
animations. As such, **we welcome everyone** who is interested in
|
|
mathematics, pedagogy, computer animations, open-source,
|
|
software development, and beyond. Manim accepts many kinds of contributions,
|
|
some are detailed below:
|
|
|
|
* Code maintenance and development
|
|
* DevOps
|
|
* Documentation
|
|
* Developing educational content & narrative documentation
|
|
* Plugins to extend Manim functionality
|
|
* Testing (graphical, unit & video)
|
|
* Website design and development
|
|
* Translating documentation and docstrings
|
|
|
|
.. note::
|
|
Please ensure that you are reading the latest version of this guide by ensuring that "latest" is selected in the version switcher.
|
|
|
|
|
|
|
|
Contributing can be confusing, so here are a few guides:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
contributing/development
|
|
contributing/docstrings
|
|
contributing/references
|
|
contributing/examples
|
|
contributing/typings
|
|
contributing/admonitions
|
|
contributing/testing
|
|
contributing/performance
|
|
contributing/internationalization
|