68 lines (46 loc) · 1.57 KB

Contributing to filelayer

Thank you for considering contributing to filelayer! This guide will help you get started.

Development Setup

Clone the repository:

git clone https://github.com/sireto/filelayer.git
cd filelayer

Create a virtual environment and install dependencies:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Install pre-commit hooks:
```
pre-commit install
```

Running Tests

pytest -v

Code Quality

We use ruff for linting and formatting, and mypy for type checking.

ruff check src/ tests/
ruff format src/ tests/
mypy src/

Pre-commit hooks run these automatically before each commit.

Submitting Changes

Fork the repository and create a feature branch from main.
Make your changes with clear, descriptive commit messages.
Add or update tests for any new or changed functionality.
Ensure all tests pass and linting is clean.
Open a pull request against main.

Reporting Issues

Use GitHub Issues to report bugs or request features.
Include steps to reproduce, expected behavior, and actual behavior.
Include your Python version and OS.

Code Style

All public functions and classes should have docstrings.
Use type hints on all function signatures.
Follow existing patterns in the codebase.

License

By contributing, you agree that your contributions will be licensed under the MIT License.