We welcome contributions from the community. Here are some guidelines.
- Before starting work on a major feature, please reach out to us via GitHub, Gitter, email, etc. We will make sure no one else is already working on it and discuss high level design to make sure everyone is on the same page.
- Small patches and bug fixes don't need prior communication.
- The Envoy source code is formated using clang-format. Thus all white space, etc. issues are taken care of automatically. The Travis tests will automatically check the code format and fail. There are make targets that can both check the format (check_format) as well as fix the code format for you (fix_format).
- Beyond code formatting, for the most part Envoy uses the [Google C++ style guidelines] (https://google.github.io/styleguide/cppguide.html). The following section covers the major areas where we deviate from the Google guidelines.
- Exceptions are allowed and encouraged where appropriate.
- References are always preferred over pointers when the reference cannot be null. This includes both const and non-const references.
- Function names using camel case starting with a lower case letter (e.g., "doFoo()").
- Struct/Class member variables have a '_' postfix (e.g., "int foo_;").
- There are probably a few other things missing from this list. We will add them as they are brought to our attention.
- Fork the repo and create your PR.
- Tests will automatically run for you.
- When all of the tests are passing, tag @lyft/network-team and we will review it and merge once our CLA has been signed (see below).
- Party time.
- We require a CLA for code contributions, so before we can accept a pull request we need to have a signed CLA. Please visit our CLA service and follow the instructions to sign the CLA.