Skip to content

Contributing

Thank you for your interest in contributing to the lampe-sdk project!

Quick Start

For detailed contributing guidelines, please refer to the main project documentation:

📖 View Full Contributing Guide

Development Setup

Prerequisites

  • Git version 2.49.0 or higher (required for proper functionality)
  • Python 3.12+
  • uv for dependency management

Getting Started

  1. Clone the repository:

sh git clone https://github.com/montagne-dev/lampe.git cd lampe

  1. Install dependencies:

sh uv sync uv run pre-commit install

  1. Run tests to ensure everything works: sh uv run pytest

Key Areas for Contribution

  • Bug fixes: Report and fix issues
  • New features: Add functionality to existing packages
  • Documentation: Improve docs and examples
  • Tests: Add test coverage
  • CI/CD: Help with GitHub Actions, Bitbucket, or GitLab integration

Questions?

If you have questions about contributing:

  1. Check the existing issues and discussions
  2. Create a new issue with the "question" label
  3. Join our community discussions

Thank you for contributing to lampe-sdk! 🚀