A community-maintained Python framework for creating mathematical animations.
Changes as Requested
Syrus Dark52794cfa5bb1
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 1602f27b9..0a67f15fe 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -1,8 +1,8 @@-#### Contributing to a Manim Community Fork - General guidelines+#### Contributing to the Manim Community Fork - General guidelinesAs this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it.-1. First, make a fork of either this Repo or the Repo from which this was Forked. ( 3b1b Repository)+1. First, make a fork of either this Repository.2. Then clone the repository you forked by the command below.```sh@@ -10,7 +10,7 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributcd manim```-3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community Fork.+3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community.```shgit remote add fork https://github.com/ManimCommunity/manim.git@@ -18,10 +18,12 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributgit checkout -b <your-branch-name> fork/master```- The first command says `git` that you are going to make a Pull Request for Manim Community.+ The first command tells `git` that you are going to make a Pull Request for Manim Community.Then the second command pulls all the commits from the Fork ( Community Fork ).The third one changes your current working branch even with Manim Community Fork master.+ Now there are three repositories that git is keeping track of: the manim community repo (referred to as "fork"), your own fork of the manim community repo (referred to by git as "origin"), and your local repository).+4. After that, you can make your changes to contents inside the `manim` directory. Then, you can commit the changes.5. Finally, before typing in `git push` enter the command below.@@ -30,8 +32,10 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributgit push -u origin <your-branch-name>```- Doing this creates a new branch with the updated contents in Github.+ Doing this creates a new branch with the updated contents in your fork on GitHub.++ Then you can make a Pull Request to the Manim Community Repo from your fork, through GitHub. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below.- Then you can make a Pull Request, with the content from Github. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below.+ - \ No newline at end of file+Also make sure to pull from upstream/master right before making a Pull Request, resolving merge conflicts locally and only then submitting the Pull Request.\ No newline at end of file