Contributing Guidelines

How to contribute to Linear Canal.

Getting Involved

We welcome contributions! Please check our GitHub repository for open issues and read this guide before submitting a pull request.

Local Dev Setup

bash

git clone https://github.com/linear-canal/linear-canal.git
cd linear-canal

# Python services
pip install -e "cli/[dev]"
pip install -e "services/scout[dev]"
pip install -e "services/api[dev]"

# Frontend
cd Frontend && npm install && npm run dev

Running Tests

bash

# Python
pytest services/ -v

# Type check
mypy cli/src services/

Pull Request Checklist

Tests pass locally.
New behaviour is covered by a test.
Commit messages are clear and scoped (e.g. feat(indexer): add delta update support).
No new secrets or credentials committed.