A community-maintained Python framework for creating mathematical animations.
Fix formatting and grammar issues in :doc:`/contributing/development` (#2904)
mostly documentation4643f306273a
diff --git a/docs/source/contributing/development.rst b/docs/source/contributing/development.rstindex 42cf68033..828b6c2c8 100644--- a/docs/source/contributing/development.rst+++ b/docs/source/contributing/development.rst@@ -9,9 +9,11 @@ For first-time contributorsFor instructions see https://git-scm.com/.-#. Fork the project. Go to https://github.com/ManimCommunity/manim and- click the "fork" button to create a copy of the project for you to work on. You will- need a GitHub account. This will allow you to make a "Pull Request" (PR)+#. Fork the project:++ Go to https://github.com/ManimCommunity/manim and click the "fork" button+ to create a copy of the project for you to work on. You will need a+ GitHub account. This will allow you to make a "Pull Request" (PR)to the ManimCommunity repo later on.#. Clone your fork to your local computer:@@ -92,7 +94,7 @@ For first-time contributorsformatted against our linter and formatters, ``black``, ``flake8``,``isort`` and ``codespell``.-You are now ready to work on manim!+You are now ready to work on Manim!Develop your contribution-------------------------@@ -217,7 +219,7 @@ generates any merge conflicts, you need to resolve them and push anupdated version of the branch to your fork of the repository.Our pipeline consists of a series of different tests that ensure-that manim still works as intended and that the code you added+that Manim still works as intended and that the code you addedsticks to our coding conventions.- **Code style**: We use the code style imposed@@ -229,7 +231,7 @@ sticks to our coding conventions.To fix code style problems, run ``flake8 <file or directory>`` for a style report, and then fix the problemsmanually that were detected by ``flake8``.-- **Tests**: The pipeline runs manim's test suite on different operating systems+- **Tests**: The pipeline runs Manim's test suite on different operating systems(the latest versions of Ubuntu, macOS, and Windows) for different versions of Python.The test suite consists of two different kinds of tests: integration testsand doctests. You can run them locally by executing ``poetry run pytest``@@ -240,8 +242,8 @@ sticks to our coding conventions.to your pull request. Make sure not to introduce any Sphinx errors, and havea look at the built HTML files to see whether the formatting of the documentationyou added looks as you intended. You can build the documentation locally- by running ``make html`` from the ``docs`` directory. Since the inheritance diagrams- require you to have `Graphviz <https://graphviz.org/>`_ installed locally.+ by running ``make html`` from the ``docs`` directory. Make sure you have `Graphviz <https://graphviz.org/>`_+ installed locally in order to build the inheritance diagrams.Finally, if the pipeline passes and you are satisfied with your changes: wait forfeedback and iterate over any requested changes. You will likely be asked to@@ -255,7 +257,7 @@ Further useful guidelines#. When submitting a PR, please mention explicitly if it includes breaking changes.#. When submitting a PR, make sure that your proposed changes are as general as- possible, and ready to be taken advantage of by all of manim's users. In+ possible, and ready to be taken advantage of by all of Manim's users. Inparticular, leave out any machine-specific configurations, or any personalinformation it may contain.@@ -280,11 +282,4 @@ You can find examples for the ``docs`` in several places:the :doc:`Example Gallery <../examples>`, :doc:`Tutorials <../tutorials/index>`,and :doc:`Reference Classes <../reference>`.-In case you are contributing, please have a look at this flowchart:--.. raw:: html-- <div class="mxgraph" style="max-width:100%;border:1px solid transparent;" data-mxgraph="{"highlight":"#0000ff","nav":true,"resize":true,"toolbar":"zoom layers lightbox","edit":"_blank","url":"https://drive.google.com/uc?id=1aKyJTloYB97IhrzwqEENOu-WQyuVWMjM&export=download"}"></div>- <script type="text/javascript" src="https://viewer.diagrams.net/embed2.js?&fetch=https%3A%2F%2Fdrive.google.com%2Fuc%3Fid%3D1aKyJTloYB97IhrzwqEENOu-WQyuVWMjM%26export%3Ddownload"></script>-**Thank you for contributing!**