We'd love your help making Connect better!
If you'd like to add new exported APIs, please open an issue describing your proposal — discussing API changes ahead of time makes pull request review much smoother. In your issue, pull request, and any other communications, please remember to treat your fellow contributors with respect!
Note that for a contribution to be accepted, you must sign off on all commits
in order to affirm that they comply with the Developer Certificate of Origin.
Make sure to configure git with the same name and E-Mail as your GitHub account,
and run git commit with the -s flag to sign. If necessary, a bot will remind
you to sign your commits when you open your pull request, and provide helpful tips.
Fork, then clone the repository:
git clone git@github.com:your_github_username/connect-kotlin.git
cd connect-kotlin
git remote add upstream https://github.com/connectrpc/connect-kotlin.git
git fetch upstream
Start by creating a new branch for your changes:
git checkout main
git fetch upstream
git rebase upstream/main
git checkout -b cool_new_feature
Make your changes, then ensure that make test still passes. (Note: If you're
changing protoc-gen-connect-kotlin, you should also run
make buildplugin and make generate to
build the plugin and re-generate its outputs before running the tests).
git commit -a
git push origin cool_new_feature
Then use the GitHub UI to open a pull request.
At this point, you're waiting on us to review your changes. We try to respond to issues and pull requests within a few business days, and we may suggest some improvements or alternatives. Once your changes are approved, one of the project maintainers will merge them.
We're much more likely to approve your changes if you:
- Add tests for new functionality.
- Write a good commit message.
- Maintain backward compatibility.