Skip to content

Contributing

Thank you for your interest in contributing to zae-limiter!

Quick Start

git clone https://github.com/zeroae/zae-limiter.git
cd zae-limiter
uv sync --all-extras
pytest

Development Guides

Guide Description
Development Setup Environment setup, running tests, code quality
LocalStack Local AWS development environment
Testing Test organization, pytest fixtures, CI
Architecture DynamoDB schema, token bucket algorithm

Detailed Reference

For comprehensive development instructions including:

  • Build commands and linting
  • Commit message conventions
  • Code review guidelines
  • Release process

See CLAUDE.md in the repository root.

Pull Request Process

  1. Create a feature branch from main
  2. Make changes following project conventions
  3. Ensure CI passes (lint, type check, tests)
  4. Submit PR for review

All changes must go through pull requests. Direct commits to main are not allowed.