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.
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"- Python 3.10 or later
- uv for dependency management
-
Fork and clone the repository:
$ gh repo fork connectrpc/connect-python --clone $ cd connect-python
-
Verify everything is working:
$ uv run poe check
We use poe as our task runner.
Run uv run poe to see all available commands.
-
Create a feature branch from an up-to-date
main:$ git checkout -b your-feature-branch -
Make your changes and ensure all checks pass:
$ uv run poe check -
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.