CONTRIBUTING.md

Contributing to the Glean Connector SDK

Thank you for your interest in contributing to the Glean Connector SDK! This document provides guidelines and instructions for contributing to this project.

Setup

1. Clone the repository
2. Set up your environment:

   # Install mise if not already installed
   brew install mise
   
   # Set up development environment
   mise run setup

Development Workflow

We use the following workflow for development:

1. Create a new branch for your feature or bugfix:

   git checkout -b feature/your-feature-name

2. Make your changes

3. Run linting and tests:

   mise run lint:fix
   mise run test:all

4. Commit your changes using commitizen:

   uv run python -m commitizen commit

5. Push your branch and create a pull request

Code Style

We follow standard Python code styles:

• Use Ruff for linting and formatting
• Use Pyright for type checking
• Follow type hints in all code

Testing

• Write unit tests for all new functionality
• Ensure all tests pass before submitting a PR

Release Process

We use commitizen for versioning:

# Perform a dry run
DRY_RUN=true mise run release

# Create a new release
mise run release

Documentation

• Update documentation for any changes to public APIs
• Include docstrings for all public classes and methods

Thank you for your contributions!