From 9a043c50cd09bb248939e0f8e06356428ed94d3d Mon Sep 17 00:00:00 2001 From: Matt Klein Date: Sun, 29 Oct 2017 10:57:46 -0700 Subject: [PATCH] readme: add contributing section (#1964) Signed-off-by: Matt Klein --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8046fda7553d..8a7e0b082fc1 100644 --- a/README.md +++ b/README.md @@ -36,15 +36,26 @@ to find out more about the origin story and design philosophy of Envoy. * [envoy-maintainers](https://groups.google.com/forum/#!forum/envoy-maintainers): Use this list to reach all core Envoy maintainers. * [Twitter](https://twitter.com/EnvoyProxy/): Follow along on Twitter! -* [Slack](https://envoyproxy.slack.com/): Slack, to get invited go [here](http://envoyslack.cncf.io). +* [Slack](https://envoyproxy.slack.com/): Slack, to get invited go [here](http://envoyslack.cncf.io). We have the IRC/XMPP gateways enabled if you prefer either of those. Once an account is created, connection instructions for IRC/XMPP can be found [here](https://envoyproxy.slack.com/account/gateways). - * NOTE: Response to user questions is best effort on Slack. For a "guaranteed" response please email + * NOTE: Response to user questions is best effort on Slack. For a "guaranteed" response please email envoy-users@ per the guidance in the following linked thread. -Please see [this](https://groups.google.com/forum/#!topic/envoy-announce/l9zjYsnS3TY) email thread +Please see [this](https://groups.google.com/forum/#!topic/envoy-announce/l9zjYsnS3TY) email thread for information on email list usage. +## Contributing + +Contributing to Envoy is fun and modern C++ is a lot less scary than you might think if you don't +have prior experience. To get started: + +* [Contributing guide](CONTRIBUTING.md) +* [Beginner issues](https://github.com/envoyproxy/envoy/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner) +* [Build/test quick start using docker](ci#building-and-running-tests-as-a-developer) +* [Developer guide](DEVELOPER.md) +* Please make sure that you let us know if you are working on an issue so we don't duplicate work! + ## Community Meeting The Envoy team meets every other Tuesday at 9am PT. The public Google calendar is here: https://goo.gl/PkDijT @@ -57,5 +68,3 @@ If you've found a vulnerability or a potential vulnerability in Envoy please let us know at envoy-security@googlegroups.com. We'll send a confirmation email to acknowledge your report, and we'll send an additional email when we've identified the issue positively or negatively. - -