Developer guide

Are you interested in contributing to Skchange? This guide will help you get started with setting up your local development environment, understanding the codebase, and following best practices for contributions.

Skchange follows the scikit-learn developer guidelines wherever possible. When in doubt, the scikit-learn documentation is the authoritative reference for API design, naming, and testing conventions.

Reporting bugs and requesting features

We use GitHub issues to track bugs and feature requests.

Before opening a new issue, please search the existing issues to see if your problem or idea has already been reported.

In your bug report, please include as many details as possible: the Skchange version, your Python version and operating system, a minimal reproducible example, and the full traceback.

In your feature request, please describe the behaviour you want and why. Also provide a code example of before (if applicable) and after the feature is implemented.

Contributing code

The following sections provide detailed instructions on how to contribute code to Skchange effectively. The guide is divided into three parts, which are intended to be read in sequence.

• Development setup
• Contributing code
• Coding guidelines

For maintainers

There is an additional section for maintainers, containing information on how to manage the project, make releases and so forth.

• For maintainers

Credits

This guide is inspired by the scikit-learn and Polars contributing guides.