Setup

Developer Guide

Thank you for contributing to MockSSH! This guide helps you set up a robust development environment.

Setup

1. Clone and Venv:

   git clone https://github.com/ncouture/MockSSH.git
   cd MockSSH
   python3 -m venv .venv
   source .venv/bin/activate
   pip install -e ".[dev]"

2. Git Hooks: Install the pre-commit hooks to ensure every commit meets our quality standards:

   pre-commit install

Tooling

• Linting/Formatting: Powered by Ruff. Run make fix to auto-format.
• Type Checking: Powered by mypy. Run make typecheck to verify.
• Testing: Powered by pytest. Run make test.

Standards

• All new code must include comprehensive type hints.
• All new features must be accompanied by an end-to-end test in the tests/ directory.
• Follow the PEP 8 style guide (enforced by Ruff).