Skip to content

Contributing to Poing AI

We welcome contributions from the community!


๐Ÿ› ๏ธ Development Setup

  1. Clone the Repository:

    git clone https://github.com/poingstudios/poing-ai.git
    cd poing-ai
    

  2. Install in Editable Mode:

    pip install -e .
    

  3. Install Documentation Dependencies:

    pip install mkdocs-material
    


๐Ÿงช Running Tests

Run the test suite with Python's built-in unittest:

python3 -m unittest discover tests

๐Ÿ“– Previewing Documentation Locally

mkdocs serve

Open http://localhost:8000 in your browser.


๐Ÿ“œ License

Poing AI is licensed under the Apache License 2.0.