Skip to content

Development

Contributing to Neonize development.

Overview

This section covers everything you need to know about contributing to Neonize, building from source, and testing.

Development Setup

Clone the Repository

Bash
1
2
git clone https://github.com/krypton-byte/neonize.git
cd neonize

Install Dependencies

Using uv (recommended):

Bash
1
uv sync --all-extras

Using pip:

Bash
1
pip install -e ".[dev,docs]"

Verify Installation

Bash
1
python -c "import neonize; print(neonize.__version__)"

Development Workflow

  1. Create a feature branch
  2. Make your changes
  3. Run tests
  4. Update documentation
  5. Submit a pull request

Code Style

We follow PEP 8 and use:

  • Ruff for linting and formatting
  • mypy for type checking
  • pytest for testing

Format Code

Bash
1
ruff format .

Check Code

Bash
1
ruff check .

Testing

Run tests:

Bash
1
pytest

With coverage:

Bash
1
pytest --cov=neonize

Documentation

Build documentation locally:

Bash
1
task docs-serve

Then visit http://127.0.0.1:8000

Need Help?