Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (57 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

87 lines (57 loc) · 1.54 KB

Contributing to Replane Python SDK

Thank you for your interest in contributing! This guide will help you get started.

Getting Started

Prerequisites

  • Python: Version 3.10 or greater

Clone the Repository

git clone https://github.com/replane-dev/replane-python.git
cd replane-python

Set Up Development Environment

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

Install the package in development mode with dev dependencies:

pip install -e ".[dev]"

Development

Run Tests

pytest

With coverage:

pytest --cov=replane

Lint

ruff check .

Type Check

mypy replane

Format

black .
isort .

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes
  4. Ensure tests pass: pytest
  5. Ensure linting passes: ruff check .
  6. Ensure type checking passes: mypy replane
  7. Commit your changes with a descriptive message
  8. Push to your fork and submit a pull request

Reporting Issues

Found a bug or have a feature request? Please open an issue on GitHub.

Community

Have questions or want to discuss Replane? Join the conversation in GitHub Discussions.

License

By contributing to Replane Python SDK, you agree that your contributions will be licensed under the MIT License.