-
Notifications
You must be signed in to change notification settings - Fork 91
First stab at MAINTAINERS.md & OWNERS.md & CONTRIBUTING.md #238
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
8adda5d
First stab at MAINTAINERS.md
oschaaf eadeb66
Merge remote-tracking branch 'upstream/master' into maintainers-doc
oschaaf 47762c3
Review feedback: CONTRIBUTING.md & OWNERS.md
oschaaf 214a037
Review-feedback: Envoy domain expertise section
oschaaf 009ab22
Review feedback
oschaaf 66ba23d
Review feedback
oschaaf f5e0521
Merge remote-tracking branch 'upstream/master' into maintainers-doc
oschaaf 7ff2dd2
Review: fix nits
oschaaf 63710cf
Review: fix bad link, .rst -> .md
oschaaf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| We welcome contributions from the community. Please read the following guidelines carefully to | ||
| maximize the chances of your PR being merged. | ||
|
|
||
| # Communication | ||
|
|
||
| * Before starting work on a major feature, please reach out to us via [GitHub](https://github.com/envoyproxy/nighthawk) or [Slack](https://envoyproxy.slack.com/archives/CDX3CGTT9). We will make sure no one else is already working on it and ask you to open a GitHub issue. | ||
| * Small patches and bug fixes don't need prior communication. | ||
|
|
||
| # Coding style | ||
|
|
||
| * Coding style mirrors [Envoy's policy](https://github.com/envoyproxy/envoy/blob/master/STYLE.md) | ||
|
|
||
| # Breaking change policy | ||
|
|
||
| Both API and implementation stability are important to Nighthawk. Since the API is consumed by clients beyond Nighthawk, breaking changes to that are prohibited. | ||
|
|
||
| # Submitting a PR | ||
|
|
||
| * Generally Nighthawk mirrors [Envoy's policy](https://github.com/envoyproxy/envoy/blob/master/CONTRIBUTING.md#submitting-a-pr) with respect to PR submission policy. | ||
| * Any PR that changes user-facing behavior **must** have associated documentation in [docs](docs) as | ||
| well as [release notes](docs/root/version_history.md). | ||
|
|
||
| # PR review policy for maintainers | ||
|
|
||
| * Generally Nighthawk mirrors [Envoy's policy](https://github.com/envoyproxy/envoy/blob/master/CONTRIBUTING.md#pr-review-policy-for-maintainers) with respect to maintainer review policy. | ||
| * See [OWNERS.md](OWNERS.md) for the current list of maintainers. | ||
|
|
||
| # DCO: Sign your work | ||
|
|
||
| Commits need to be signed off. See [here](https://github.com/envoyproxy/envoy/blob/master/CONTRIBUTING.md#dco-sign-your-work). | ||
|
|
||
|
|
||
| ## Triggering CI re-run without making changes | ||
|
|
||
| See [here](https://github.com/envoyproxy/envoy/blob/master/CONTRIBUTING.md#triggering-ci-re-run-without-making-changes). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Maintainers | ||
|
|
||
| This document aims to assist [maintainers](OWNERS.md). | ||
|
|
||
| ## Envoy domain expertise | ||
|
|
||
| As a guideline, concepts in Nighthawk that are derived from Envoy | ||
| require someone with Envoy domain expertise in review. Notable examples | ||
| are the way Nighthawk internally computes cluster configuration, its | ||
| connection pool derivations, the `StreamDecoder` class, as well as anything related to the Nighthawk test server. | ||
|
|
||
| See [OWNERS.md](OWNERS.md) to find maintainers with expertise of | ||
| Envoy internals. | ||
|
|
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add some stuff on how to spot which changes are Nighthawk local vs. those that require deeper Envoy internals and architecture knowledge?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
| ## Pre-merge checklist | ||
|
|
||
| - Does the PR have breaking changes? Then that should be explicitly mentioned in the [version history](docs/root/version_history.md). | ||
| - New features should be added to the [version history](docs/root/version_history.md). | ||
| - Breaking changes to the [protobuf APIs](api/) are not allowed. | ||
|
|
||
| ## Updates to the Envoy dependency | ||
|
|
||
| We try to [regularly synchronize our Envoy dependency](https://github.com/envoyproxy/nighthawk/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aclosed+%22update+envoy%22+) with the latest revision. Nighthawk reuses large parts of Envoy's build system and CI infrastructure. When we update, that looks like: | ||
|
|
||
| - A change to [repositories.bzl](bazel/repositories.bzl) to update the commit and SHA. | ||
| - A sync of [.bazelrc](.bazelrc) with [Envoy's version](https://github.com/envoyproxy/envoy/blob/master/.bazelrc) to update our build configurations. | ||
| - A sync of the build image sha used in the [ci configuration](.circleci/config.yml) with [Envoy's version](https://github.com/envoyproxy/envoy/blob/master/.circleci/config.yml) to sync our CI testing environment. | ||
| - Sometimes the dependency update comes with changes that break our build. We include any changes required to Nighthawk to fix that. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| * See [CONTRIBUTING.md](CONTRIBUTING.md) for general contribution guidelines. | ||
|
|
||
| This page lists all active maintainers and their areas of expertise. This can be used for | ||
| routing PRs, questions, etc. to the right place. | ||
|
|
||
| # Maintainers | ||
|
|
||
| * Otto van der Schaaf ([oschaaf](https://github.com/oschaaf)) (oschaaf@we-amp.com) | ||
| * All things Nighthawk | ||
| * Harvey Tuch ([htuch](https://github.com/htuch)) (htuch@google.com) | ||
|
oschaaf marked this conversation as resolved.
|
||
| * Envoy internals, architecture and performance methodology. | ||
| * John Plevyak ([jplevyak](https://github.com/jplevyak)) (jplevyak@google.com) | ||
| * Envoy internals and architecture. | ||
| * Jakub Sobon ([mum4k](https://github.com/mum4k)) (mumak@google.com) | ||
| * APIs, general functionality and miscellany. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.