Developer Guide

Documentation for contributing to and understanding liblevenshtein-rust internals.

Contents

Architecture

Deep dive into the library architecture:

• Core trait system (Dictionary, DictionaryNode)
• Distance computation algorithms
• Memory management strategies
• Backend implementations

Building

Instructions for building the project:

• Build requirements
• Feature flags and optional dependencies
• Cross-compilation
• Development builds vs. release builds

Contributing

Guidelines for contributing:

• Code style and conventions
• Testing requirements
• Pull request process
• Issue reporting

Performance

Performance optimization guide:

• Profiling tools and techniques
• Benchmark interpretation
• Optimization strategies
• Common performance pitfalls

Publishing

Release and publishing procedures:

• Version management
• Release checklist
• Publishing to crates.io
• Documentation updates

Cargo workspace layout

Why the procedural-macro package is verified as an independent workspace and which commands CI must run for complete coverage.

Related Documentation

• Design Documents - Algorithm and feature designs
• Bug Reports - Known issues and fixes
• Research - Optimization research and experiments