Contributing¶

Contributions are welcome. The project is hosted on GitHub.

Installing from source¶

Clone the repository and install with all extras:

git clone https://github.com/TheSkyentist/unite.git
cd unite
pip install -e ".[dev]"

Using Pixi (recommended for development)¶

Pixi manages both the Python environment and common tasks:

git clone https://github.com/TheSkyentist/unite.git
cd unite
pixi install

Common development tasks:

pixi run test      # run the test suite
pixi run lint      # check code style
pixi run docs     # build these docs

Reporting issues¶

If you find a bug or unexpected behaviour, please open an issue. Include a minimal reproducible example and the version of unite you are using (import unite; print(unite.__version__)).

Suggesting features¶

Feature requests are also tracked via GitHub Issues. Describe the use-case and, if possible, sketch out what the API might look like.

Pull requests¶

Fork the repository and create a branch from main.
Install the development environment with Pixi:
```
pixi install
```
Make your changes, then run the test suite, linter, and formatter before pushing:
```
pixi run test
pixi run lint
pixi run format
```
Open a pull request against main. The CI will run automatically.

All contributions — bug fixes, new features, documentation improvements, and additional instrument support — are appreciated.