manim/docs/source/contributing.rst
Mysaa 065c7612a2
Prepare documentation for translation (#862)
* Perparing for internationalization

* On my way to i18n

* Making initial .pot

* Apply translations in fr

review completed for the source file '/docs/i18n/gettext/examples/camera_settings.pot'
on the 'fr' language.

* Apply translations in fr

review completed for the source file '/docs/i18n/gettext/examples/camera_settings.pot'
on the 'fr' language.

* Added some languages and changing files

* Removing translations, keeping only en

* Updating the commit history so docs are redownloaded

* Adding a bit of texts to add contributing.rst

* Apply translations in fr

at least 5% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.geometry.CubicBezier.po'
on the 'fr' language.

 Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format

* Apply translations in fr

at least 5% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.types.vectorized_mobject.po'
on the 'fr' language.

 Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format

* Translate /docs/i18n/en/LC_MESSAGES/index.po in fr

at least 15% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/index.po'
on the 'fr' language.

 Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format

* Apply translations in fr

at least 15% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.geometry.CubicBezier.po'
on the 'fr' language.

 Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format

* Apply translations in fr

at least 15% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.types.vectorized_mobject.po'
on the 'fr' language.

 Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format

* Modified the Makefile a bit

* Added a first script to strip untranslatable content out

* Added some stripping code that needs to be re-worked.

* Finished the awk script. Commented it (a little gift to my future self).
Still need to test the generated files
Also removed the gettext folder from .gitignore

* Added folders in the .gitignore and comments to the awk script

* Pof, added the readyForTranslation file

* Removed french translations, hoping transifex will reset them

* Modified the files to trigger transifex changes

* Made the comment made by stripUntranslatable compatible with .po files syntax

* Tried another fix

* Another one bites the dust

* Why the reason is not necessary to involve ?

* Fixed .... i think

* Translate /docs/i18n/en/LC_MESSAGES/index.po in fr

at least 1% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/index.po'
on the 'fr' language.

 Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format

* Added a paragraph in the docs explaining how to translate

* Changed the contributing a bit, thanks jpitz

* Tweaked the docs part a bit more

* Fixed a link and updated i18n

* REREREupdated the link

* How did i get my driving licence ?

* Little test about i18n build

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* New internationalized files.

* Corrected some grammar errors. Whoops.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed typo in awk file comments.

* Fix the precommit issues.

* Apply suggestions from code review - Rewrote parts of the contributing text.

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Add link to discord server in translation.rst

* Suppression des en-tête inutiles des fichiers PO.

* Changed i18nService role to TranslationAdmin

* Translate /docs/i18n/en/LC_MESSAGES/index.po in fr

reviewed for the source file '/docs/i18n/en/LC_MESSAGES/index.po'
on the 'fr' language.

* Renamed the internationalization doc file. + Now every translatable string is sent to translation.

* Minor copyedit suggested by @Darylgolden

Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com>
Co-authored-by: Mysaa <mysaa@bernard.com.de>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: GameDungeon <60719255+GameDungeon@users.noreply.github.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-09-24 20:17:43 +08:00

40 lines
1.3 KiB
ReStructuredText

############
Contributing
############
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/internationalization