​

Contributing to Laddr

​

Getting Started

​

1. Fork the Repository

​

2. Clone Your Fork

git clone https://github.com/your-username/Laddr.git
cd Laddr

​

3. Set Up Development Environment

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install in development mode
pip install -e lib/laddr

# Install development dependencies
pip install -r requirements-dev.txt

​

Development Workflow

​

1. Create a Branch

git checkout -b feature/your-feature-name

​

2. Make Changes

​

3. Test Your Changes

# Run tests
pytest

# Run linter
ruff check .

# Run type checker
mypy lib/laddr

​

4. Commit Your Changes

git add .
git commit -m "feat: Add new feature"

​

5. Push and Create Pull Request

git push origin feature/your-feature-name

​

Code Style

​

Python Style

• Follow PEP 8
• Use type hints
• Write docstrings for all functions and classes
• Keep functions focused and small

​

Commit Messages

• feat: - New feature
• fix: - Bug fix
• docs: - Documentation changes
• refactor: - Code refactoring
• test: - Test additions/changes

​

Areas for Contribution

​

Documentation

• Improve existing documentation
• Add examples
• Fix typos and errors

​

Code

• Bug fixes
• New features
• Performance improvements
• Test coverage

​

Examples

• Add example agents
• Create tutorial content
• Share use cases

​

Questions?

1. Check existing issues on GitHub
2. Open a new issue for discussion
3. Join our community discussions

​

Next Steps

• Getting Started - Setup guide
• Agent Configuration - Learn about agents