Skip to content

Commit

Permalink
docs: added contribution doc
Browse files Browse the repository at this point in the history
  • Loading branch information
drageelr committed Dec 6, 2022
1 parent 2c79202 commit 81e1387
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing Guidelines

## Setup

### Install git
For instructions see https://git-scm.com/.

### Fork the project
Go to https://github.com/drageelr/manim-data-structures and click the "fork" button.

### Clone your fork
```bash
git clone https://github.com/<your-username>/manim-data-structures.git
```
Once your fork is cloned, change the directory to enter the project folder:
```bash
cd manim-data-structures
```

### Add upstream repository
```bash
git remote add upstream https://github.com/drageelr/manim-data-structures.git
```
Now, `git remote -v` should show two remotes:
* `origin`: Your forked repository.
* `upstream`: The Manim Data Structures repository

### Install dependencies
* Install [Poetry](https://python-poetry.org/) by following the instructions on this [link](https://python-poetry.org/docs/master/#installing-with-the-official-installer).
* 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.
* 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`.

## Development

### Fetch the latest code from upstream
```bash
git checkout dev
git pull upstream dev
git push origin dev
```

### Initiate a PR
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.

### Closing note
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.

Thanks for contributing 😁!

0 comments on commit 81e1387

Please sign in to comment.