Skip to content

Contributing

We are waiting for your contributions to pydantic_collection.

How to contribute

## 1. Clone your fork repository
$ git clone git@github.com:<your username>/pydantic-collection.git
$ cd pydantic-collection

## 2. Create `venv` with python3.8
$ python3.8 -m venv venv38
$ source venv38/bin/activate  

## 3. Install dependencies
$ python3 -m pip install ".[all]" 

## 4. Create new branch and rewrite code.
$ git checkout -b new-branch

## 5. Run unittest (you should pass all test and coverage should be 100%)
$ ./scripts/test.sh

## 6. Format code
$ ./scripts/format.sh

## 7. Check lint (mypy)
$ ./scripts/lint.sh

## 8. Commit and Push...