-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Add Contribution guideline in Readme #127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
99f8492
Add Contribution guideline in Readme
naveen521kk 2b5e209
Move to CONTRIBUTING.md
naveen521kk 52794cf
Changes as Requested
naveen521kk 4d3ce59
Fix image path
naveen521kk 8c6bca8
Change \ to /
naveen521kk 7a9ace4
Add General Contribution
naveen521kk b462fc2
names
PgBiel 8537939
Update with asked changes
naveen521kk f223119
dot
PgBiel 038936b
Change name
naveen521kk 554714c
Merge branch 'contrib-guide' of https://github.com/naveen521kk/manim …
naveen521kk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # General Contribution Guidelines | ||
|
|
||
| 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). | ||
| 2. (For the maintainers of this repo) Label PRs appropriately. | ||
| 3. Link relevant issues. | ||
| 4. Ensure compatibility with the latest changes in the repo. | ||
|
|
||
| ## Contributing to the Manim Community Fork - General instructions | ||
|
|
||
| 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. | ||
|
|
||
| 1. First, make a fork of this repository. | ||
| 2. Then clone the repository you forked using the command below (bash/zsh). | ||
|
|
||
| ```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 in order to be able to contribute to Manim Community. | ||
|
|
||
| ```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 tells `git` that you are going to make a Pull Request to Manim Community. | ||
| The second command pulls all the commits from the aforementioned fork. | ||
| Finally, the third one makes your current working branch up-to-date with Manim Community's master branch. | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| 5. Finally, instead of typing in `git push`, enter the command below. | ||
|
|
||
| ```sh | ||
| git push -u origin <your-branch-name> | ||
| ``` | ||
|
|
||
| Doing so creates a new branch with the updated contents of 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 the `base repository` and your fork and branch as `head repository` - see the picture below. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.