Contributing to Farg #

Thank you for your interest in contributing to Farg. This guide will help you get started with development.

Quick Start #

# Install mise (recommended)
curl https://mise.run | sh

# Install toolchain and run all checks
mise install
mise run check

# Run tests
mise run test

# Format and lint
mise run format
mise run lint

# Using an AI agent? Link its config once
mise run setup:agents

Without mise, run scripts directly from scripts/:

./scripts/check/rust
./scripts/test/rust
./scripts/format/rust
./scripts/lint/rust

Development Workflow #

1. Create a branch for your changes
2. Make your changes following the code style guide
3. Run mise run check to verify everything passes
4. Submit a pull request

Common Tasks #

Task	Command	Description
Check	mise run check	Verify compilation
Test	mise run test	Run tests with coverage
Format	mise run format	Format all files
Lint	mise run lint	Lint all files
Audit	mise run audit	Check for vulnerabilities

Filter tests: mise run test:rust --filter xyz

Guides #

Guide	Topics
Development Tasks	Available commands and toolchain
Code Style	Formatting, linting, code organization
Testing	Test structure and conventions

Documentation #

• Architecture Decision Records - Design decisions and rationale
• Writing ADRs - How to record a decision once it is made
• Writing RFCs - How to propose a change before it is made