Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING document #13

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing

We'd love your help making `envoy-demo` better.

If you'd like to make a substantial change, please [open an issue][open-issue]
describing your proposal — discussing large 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][cla]
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][fork], then clone the repository:

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

You will need an up-to-date installation of the Go programming language to work
on the gRPC server, and an installation of Docker or Podman to with Docker
Compose to run the demo setup.

To start the demo setup, run the default Make target:

```bash
make
```

## Making Changes

Start by creating a new branch for your changes:

```bash
git checkout main
git fetch upstream
git rebase upstream/main
git checkout -b cool_new_feature
```

Make your changes, then ensure that `make` still works.
When you're satisfied with your changes, push them to your fork.

```bash
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:

- Document added code.
- Write a [good commit message][commit-message].
- Maintain backward compatibility.

[fork]: https://github.com/connectrpc/envoy-demo/fork
[open-issue]: https://github.com/connectrpc/envoy-demo/issues/new
[cla]: https://cla-assistant.io/connectrpc/envoy-demo
[commit-message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html