Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

64 lines (48 loc) · 2.03 KB

Contributing

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 you'll need to sign Buf's Contributor License Agreement before we can accept any of your contributions. If necessary, a bot will remind you to accept the CLA when you open your pull request.

Setup

Fork, then clone the repository:

git clone [email protected]:your_github_username/connect-kotlin.git
cd connect-kotlin
git remote add upstream https://github.com/connectrpc/connect-kotlin.git
git fetch upstream

Making Changes

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.