Contributing Guide

Welcome to Torale! We're glad you're interested in contributing.

Getting Started

Development Setup - Clone, install dependencies, and run locally

Testing Guide - Unit tests, integration tests, and test fixtures

Code Conventions - Style guide, commit messages, and project standards

Development Workflow

1. Fork & Clone: Fork the repository and clone locally
2. Setup: Follow the Development Setup guide
3. Code: Make your changes following Code Conventions
4. Test: Run just test and just lint before committing
5. Commit: Use conventional commits (feat:, fix:, etc.)
6. Push: CI handles testing and deployment

Prerequisites

• Python 3.9+
• Node 20+
• Docker & Docker Compose
• UV package manager

Getting Started

Start with the Development Setup guide to get Torale running locally, then review Code Conventions before making changes.