Skip to main content

Contributing

Clone Repository

git clone https://github.com/qasimio/Foldr.git

cd Foldr

Create Environment

python -m venv .venv

source .venv/bin/activate

Install development dependencies:

pip install -e ".[dev]"

Before Opening a Pull Request

Run tests:

python -m pytest tests/ -v

Pull Request Guidelines

  • one feature or fix per pull request
  • include tests
  • update documentation when needed
  • update the changelog

Reporting Bugs

Include:

  • operating system
  • Python version
  • Foldr version
  • command executed
  • relevant logs