CONTRIBUTING.md

Contributing

Steps

Create an Issue

Create an issue and describe your idea and proposed changes.

Fork the repo

Fork the repo into your own account and create a new branch.

Do your thing

Make your changes locally.

For documentation on the development environment for this repo, see the Development Section.

Commit your changes

Commit your changes to your new branch.

Create a Pull Request

When you are ready, Create a PR for review.

Development

This project uses poetry for dependency management and package build/publishing.

You can follow their instructions on installation.

Install Dependencies

poetry install --dev

Run Tests

poetry run pytest

With Coverage

poetry run pytest --cov vercel

With Parallelization

poetry run pytest --cov vercel -n 2

Run Formatter

poetry run black .

Build / Publish

Make sure you bump the version of the package according to semver. Then run:

poetry publish --build

This will prompt you for the username and password for the package.