CONTRIBUTING.md

Contributing

Install pdm

pipx install pdm

• See more at: https://pdm-project.org/latest/#installation

Set up environment

git clone [email protected]:waketzheng/fast-dev-cli.git
cd fast-dev-cl

• Create virtual environment and install dependencies by pdm

# Create virtual environment
pdm use 3

# Activate virtual environment
source .venv/*/activate  # for Linux/MacOS/GitBash
.venv\Scripts\activate  # For Windows

# Install dependenices
python -m ensurepip
python -m pip install --upgrade pip
pdm export --without-hashes -o dev_requirements.txt
python -m pip install -r dev_requirements.txt
python -m pip install -e .

Lint code

./scripts/format.py

Check

./scripts/check.py

Test

pipx install poetry
pipx inject poetry poetry-plugin-version
# or: pdm run python -m pip install poetry poetry-plugin-version
./scripts/test.py