Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (48 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.69 KB

Contributing to connect-python

Before You Contribute

If you're planning to add or change a public API, please open an issue describing your proposal before starting work. This helps ensure alignment with the project's direction and makes the review process smoother for everyone.

Developer Certificate of Origin

All commits must be signed off to affirm compliance with the Developer Certificate of Origin. Configure your git identity to match your GitHub account, then use the -s flag when committing:

$ git commit -s -m "your commit message"

Setting Up Your Development Environment

Prerequisites

  • Python 3.10 or later
  • uv for dependency management
  • just for running tasks

Installation

  1. Fork and clone the repository:

    $ gh repo fork connectrpc/connect-python --clone
$ cd connect-python

  2. Verify everything is working:

    $ uv run just check

Development Workflow

We use just as our task runner. Run uv run just --list to see all available commands.

Submitting a Pull Request

  1. Create a feature branch from an up-to-date main:

    $ git checkout -b your-feature-branch

  2. Make your changes and ensure all checks pass:

    $ uv run just check

  3. Commit with a sign-off and a clear message, then push to your fork and open a pull request.

Pull requests are more likely to be accepted when they:

  • Include tests for new functionality
  • Maintain backward compatibility
  • Have clear commit messages

We aim to respond to issues and pull requests within a few business days.