Contributing

Thank you for your interest in contributing.

Contributing can be confusing, so here are a guide:

  1. Install git:

    For intructions see https://git-scm.com/.

  2. Fork the project. Go to https://github.com/ManimCommunity/awesome-manim and click the “fork” button to create a copy of the repository for you to work on. You will also need a Github account.

  3. Clone your fork to your local computer:

    git clone https://github.com/<your-username>/awesome-manim.git
    

    Warning

    Do not clone the ManimCommunity/awesome-manim repository. You must clone your own fork.

  4. Change the directory to enter the project folder:

    cd awesome-manim
    
  5. Do your alterations and then commit and push then:

    git add <your-files>
    git commit -m "<message>"
    git push
    
  6. Now you go to your github repository page and create a pull request.

  7. Someone will check and accept or not your contribution