Contributing¶

Contributions to ACMEOW are welcome!

Development Setup¶

Clone the repository:

git clone https://github.com/miichoow/ACMEOW.git
cd ACMEOW

Create a virtual environment:

python -m venv .venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate     # Windows

Install in development mode:
```
pip install -e ".[dev]"
```

Running Tests¶

pytest

Type Checking¶

mypy src/acmeow/

Linting¶

ruff check src/acmeow/

Building Documentation¶

cd docs
pip install -r requirements.txt
make html

Code Style¶

Follow PEP 8
Use type annotations
Write docstrings in Google style
Keep line length under 100 characters

Pull Requests¶

Fork the repository
Create a feature branch
Make your changes
Run tests and linting
Submit a pull request

Issues¶

Report bugs and request features at: https://github.com/miichoow/ACMEOW/issues