Development Guide

Welcome to the bice development guide. This section provides information for contributors and maintainers on how to set up the development environment, follow our coding standards, and contribute to the project.

• Getting Started
  • Prerequisites
  • Installation
  • Verifying the Setup
• Coding Standards
  • Python Version
  • Style and Formatting
  • Type Checking
  • Docstrings
• Testing
  • Running Tests
  • Test Structure
  • Writing New Tests
• Documentation
  • Tools
  • Building Documentation Locally
  • Architecture Documentation
  • API Documentation
• Release Process
  • Triggering a Release
  • Distribution Channels
  • CI/CD Configuration
  • Pipeline Workflow

Overview

The goal of this guide is to ensure a consistent and high-quality codebase while making it easy for new developers to get started. We use modern Python tools and best practices to automate linting, formatting, and type checking.