Skip to content

Commit 81e1387

Browse files
committed
docs: added contribution doc
1 parent 2c79202 commit 81e1387

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing Guidelines
2+
3+
## Setup
4+
5+
### Install git
6+
For instructions see https://git-scm.com/.
7+
8+
### Fork the project
9+
Go to https://github.com/drageelr/manim-data-structures and click the "fork" button.
10+
11+
### Clone your fork
12+
```bash
13+
git clone https://github.com/<your-username>/manim-data-structures.git
14+
```
15+
Once your fork is cloned, change the directory to enter the project folder:
16+
```bash
17+
cd manim-data-structures
18+
```
19+
20+
### Add upstream repository
21+
```bash
22+
git remote add upstream https://github.com/drageelr/manim-data-structures.git
23+
```
24+
Now, `git remote -v` should show two remotes:
25+
* `origin`: Your forked repository.
26+
* `upstream`: The Manim Data Structures repository
27+
28+
### Install dependencies
29+
* Install [Poetry](https://python-poetry.org/) by following the instructions on this [link](https://python-poetry.org/docs/master/#installing-with-the-official-installer).
30+
* Run `poetry install` inside the fork directory to install all dependencies. This command also creates a virtual environment which you can later enter by running `poetry shell` from within the forked directory.
31+
* Install pre-commit by running `poetry run pre-commit install`. This ensures that each commit is properly formatted against the linters `black`, `flake8` and `isort`.
32+
33+
## Development
34+
35+
### Fetch the latest code from upstream
36+
```bash
37+
git checkout dev
38+
git pull upstream dev
39+
git push origin dev
40+
```
41+
42+
### Initiate a PR
43+
Once you have finalized your contribution, navigate to this [link](https://github.com/drageelr/manim-data-structures/pulls) to create a new pull request and submit it.
44+
45+
### Closing note
46+
Once your PR is approved, it will be merged into the `dev` branch and eventually your contribution will make it through to the next release.
47+
48+
Thanks for contributing 😁!

0 commit comments

Comments
 (0)