From 2825d2b4be31b945163e951f42d82a0587f9991f Mon Sep 17 00:00:00 2001 From: Martin Taillefer Date: Sat, 8 Apr 2017 03:22:36 -0700 Subject: [PATCH] A few doc changes for consistency across repos. --- CONTRIBUTING.md | 40 ++++------------------------------------ README.md | 13 ++++--------- 2 files changed, 8 insertions(+), 45 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 936e3c8f91b..1c21f8a4311 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 26a33ca4b89..9c478e2f3f0 100644 --- a/README.md +++ b/README.md @@ -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).