Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 1.57 KB

CONTIBUTION.md

File metadata and controls

59 lines (45 loc) · 1.57 KB

Welcome to Parrotfish contributing guide

Thank you for investing your time in contributing to our project! ✨.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started:

Getting started

Steps to run parrotfish while making changes:

  1. Create and activate a virtualenv.
python3 -m venv src-env
source src-env/bin/activate
  1. Install required packages.
pip install -r requirements.txt -r requirements-dev.txt
  1. Install Parrotfish as an editable package.
export PACKAGE_VERSION="dev"
pip install -e .
  1. Run it!
parrotfish -h

Running tests:

pytest -v --cov

Versioning:

We use commitizen to generate the CHANGELOG.md, bump the version and create a tag.

Configuring commitizen:

cz init

Bump version:

cz bump

A tag is created with the new version. When you push this tag a packaging pipeline will be triggered which will create a release, package the parrotfish tool and attaches that as an asset to the release.