Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.03 KB
Raw

Contributing to pyinfra

Third party pull requests help expand pyinfra's functionality and are essential to it's continued growth. This guide should help get you started adding additional modules/facts to pyinfra.

Dev setup

# Create a virtualenv
virtualenv /path/to/venv

# Clone the repo
git clone git@github.com:Fizzadar/pyinfra.git

# Install the package in editable mode with development requirements
pip install -e .[dev]

Tests

Use nosetests or the bundled helper script to run tests. This helper script also counts coverage:

# Test everything (API, modules & facts)
scripts/test.sh

# Set individual bits
scripts/test.sh [api|modules|facts]

Guides

Code

  • Always add tests for modules (operations + facts)
  • Keep code style consistent:
    • ~90 character lines
    • no hanging indents
    • single quotes everywhere possible