Skip to content

Commit

Permalink
A few doc changes for consistency across repos. (envoyproxy#235)
Browse files Browse the repository at this point in the history
  • Loading branch information
geeknoid authored Apr 9, 2017
1 parent 38a15cb commit 71097de
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 45 deletions.
40 changes: 4 additions & 36 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,5 @@
# Contributing guidelines
# Contribution guidelines

So, you want to hack on the Istio Proxy? Yay!

- [Contributor license agreements](#contributor-license-agreements)
- [Contributing a patch](#contributing-a-patch)

## Contributor license agreements

We'd love to accept your patches! Before we can take them, you have to jump a
few legal hurdles.

Please fill out the [Google CLA](https://cla.developers.google.com).

Once you are CLA'ed, we'll be able to accept your pull requests. This is necessary
because you own the copyright to your changes, even after your contribution
becomes part of this project. So this agreement simply gives us permission
to use and redistribute your contributions as part of the project.

***NOTE***: Only original source code from you and other people that have
signed the CLA can be accepted into the repository. This policy does not
apply to [third_party](third_party/) and [vendor](vendor/).

## Contributing a patch

If you're working on an existing issue, simply respond to the issue and express
interest in working on it. This helps other people know that the issue is
active, and hopefully prevents duplicated efforts.

If you want to work on a new idea of relatively small scope:

1. Submit an issue describing your proposed change to the repo in question.
1. The repo owners will respond to your issue promptly.
1. If your proposed change is accepted, and you haven't already done so, sign a
Contributor License Agreement (see details above).
1. Fork the repo, develop, and test your changes.
1. Submit a pull request.
So, you want to hack on the Istio proxy? Yay! Please refer to Istio's overall
[contribution guidelines](https://github.com/istio/istio/blob/master/CONTRIBUTING.md)
to find out how you can help.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,7 @@ Server Side Features:

- *Monitoring & Logging*. The Proxy can report server-side metrics and logs to the Mixer.

To learn more...

- User guide coming soon!
- [Contributing to the project](./CONTRIBUTING.md)

### Filing issues

If you have a question about an Istio proxy or have a problem using one, please
[file an issue](https://github.com/istio/proxy/issues/new).
Please see [istio.io](https://istio.io)
to learn about the overall Istio project and how to get in touch with us. To learn how you can
contribute to any of the Istio components, including the proxy, please
see the Istio [contribution guidelines](https://github.com/istio/istio/blob/master/CONTRIBUTING.md).

0 comments on commit 71097de

Please sign in to comment.