Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (33 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 1.14 KB

Contributing to pyinfra

🎉 Hello! Thank you for taking the time to contribute 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]"

Generate documentation locally

To generate:

scripts/build_docs.sh

To view (on mac):

open docs/build/index.html

Tests

Use pytest to run tests, or pytest --cov to run with coverage.

Guides

Code

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