Skip to content

Developer Guide

Welcome to the Developer Guide for CANARI-ML! This section is designed to help new and existing contributors understand the structure, standards, and tools used in the project.

Whether you're fixing a bug, adding a feature, or simply exploring how things work, this guide provides the essential information to get started efficiently and contribute effectively.

ToDo

## What You'll Find in This Section

**Project Structure**: Understand how the codebase is organised and why.

**Development Setup**: Step-by-step instructions to set up your local development environment.

**Running the Project**: Learn how to run the application and its components.

**Testing**: How to run and write tests to ensure your changes are safe and reliable.

**Code Standards**: Coding conventions, linting, and formatting tools we use.

**Workflow**: Our Git branching strategy and how to submit pull requests.

**Dependencies**: How we manage packages and virtual environments.

**Documentation**: How to build and contribute to the project documentation.

Prerequisites

To follow this guide, you should have a basic understanding of:

  • Python and its packaging approach
  • Python virtual environments (e.g., venv, virtualenv, conda)
  • Git and GitHub