Contributing¶

Development Setup¶

Getting Started¶

Fork and clone the repository

git clone https://github.com/YOUR_USERNAME/anscombe-transform.git
cd anscombe-transform

Install Hatch

Via pip:

pip install hatch

Or directly.

Create a development environment

# See available environments
hatch env show

# Enter a test environment
hatch shell test.py3.11-2.2

Run tests

# Run all tests
hatch run test:pytest tests/

# Run specific test file
hatch run test:pytest tests/test_codec.py

# Run with coverage
hatch run test:pytest tests/ --cov=src/anscombe_transform

Testing¶

The project uses pytest for testing. Tests are organized in the tests/ directory.

Building Documentation¶

Local Documentation Server¶

# Install docs dependencies
hatch run docs:mkdocs serve

# View at http://127.0.0.1:8000

Building Documentation¶

# Build static site
hatch run docs:mkdocs build

# Output in site/

Getting Help¶

Questions? Open a GitHub Discussion
Bug reports? Open an Issue

License¶

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