A community-maintained Python framework for creating mathematical animations.
Move to CONTRIBUTING.md
Syrus Dark2b5e209da292
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 000000000..1602f27b9--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,37 @@+#### Contributing to a Manim Community Fork - General guidelines++As 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)+2. Then clone the repository you forked by the command below.++ ```sh+ git clone <your-fork-url>+ cd 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.++ ```sh+ git remote add fork https://github.com/ManimCommunity/manim.git+ git fetch fork+ git checkout -b <your-branch-name> fork/master+ ```++ The first command says `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.++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.++ ```sh+ git push -u origin <your-branch-name>+ ```++ Doing this creates a new branch with the updated contents in Github.++ 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 filediff --git a/README.md b/README.mdindex 287c351a4..177d5c9ec 100644--- a/README.md+++ b/README.md@@ -252,47 +252,7 @@ Documentation is in progress at [eulertour.com/docs](https://www.eulertour.com/dThe issues board is reserved for bugs, and future features planned for Manim. If you need help installing or using Manim, please take a look at [the Reddit Community](https://www.reddit.com/r/manim) or the [Discord Community](https://discord.gg/mMRrZQW)## Contributing-Is always welcome. In particular, there is a dire need for tests and documentation.--#### Contributing to a Manim Community Fork - General guidelines--As 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)-2. Then clone the repository you forked by the command below.-- ```sh- git clone <your-fork-url>- cd 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.-- ```sh- git remote add fork https://github.com/ManimCommunity/manim.git- git fetch fork- git checkout -b <your-branch-name> fork/master- ```-- The first command says `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.--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.-- ```sh- git push -u origin <your-branch-name>- ```-- Doing this creates a new branch with the updated contents in Github.-- 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.-- --+Is always welcome. In particular, there is a dire need for tests and documentation. Check out [CONTRIBUTING.md](https://github.com/ManimCommunity/manim/blob/master/CONTRIBUTING.md) for more details.## License