Skip to content

Commit b000ca6

Browse files
authored
Merge pull request #127 from naveen521kk/contrib-guide
Add Contribution guideline in Readme
2 parents 0261b83 + 554714c commit b000ca6

File tree

3 files changed

+51
-1
lines changed

3 files changed

+51
-1
lines changed

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# General Contribution Guidelines
2+
3+
1. If code changes are being made, please include documentation **following the guidelines in the Wiki** (typings are also welcome, but we can probably do them for you, given the documentation).
4+
2. (For the maintainers of this repo) Label PRs appropriately.
5+
3. Link relevant issues.
6+
4. Ensure compatibility with the latest changes in the repo.
7+
8+
## Contributing to the Manim Community Fork - General instructions
9+
10+
As this is a Fork of [Manim by 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. Because of that, here is a small guide on it.
11+
12+
1. First, make a fork of this repository.
13+
2. Then clone the repository you forked using the command below (bash/zsh).
14+
15+
```sh
16+
git clone <your-fork-url>
17+
cd manim
18+
```
19+
20+
3. Now that you have cloned the repo, before making any changes, you have to enter the commands below in order to be able to contribute to Manim Community.
21+
22+
```sh
23+
git remote add fork https://github.com/ManimCommunity/manim.git
24+
git fetch fork
25+
git checkout -b <your-branch-name> fork/master
26+
```
27+
28+
The first command tells `git` that you are going to make a Pull Request to Manim Community.
29+
The second command pulls all the commits from the aforementioned fork.
30+
Finally, the third one makes your current working branch up-to-date with Manim Community's master branch.
31+
32+
Now there are three repositories that git is keeping track of: the manim community repo (referred to as "fork"), your own fork of it (referred to by git as "origin"), and your local repository.
33+
34+
4. After that, you can make your changes to the repo's files (the code is in the `manim` directory). Then, you can commit said changes.
35+
36+
5. Finally, instead of typing in `git push`, enter the command below.
37+
38+
```sh
39+
git push -u origin <your-branch-name>
40+
```
41+
42+
Doing so creates a new branch with the updated contents of your fork on GitHub.
43+
44+
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 the `base repository` and your fork and branch as `head repository` - see the picture below.
45+
46+
![pull-requests-example-manim-community](./readme-assets/pull-requests.PNG)
47+
48+
Also make sure to pull from upstream/master right before making a Pull Request, resolve merge conflicts locally and only then submit the Pull Request.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,9 @@ Documentation is in progress at [eulertour.com/docs](https://www.eulertour.com/d
252252
The 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)
253253

254254
## Contributing
255-
Is always welcome. In particular, there is a dire need for tests and documentation.
255+
Is always welcome. In particular, there is a dire need for tests and documentation.
256+
257+
For instructions, guidelines and other details, please check out the file [CONTRIBUTING.md](https://github.com/ManimCommunity/manim/blob/master/CONTRIBUTING.md).
256258

257259
## License
258260

readme-assets/pull-requests.PNG

13.4 KB
Loading

0 commit comments

Comments
 (0)