-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Matt Klein <[email protected]>
- Loading branch information
1 parent
cb0a6db
commit 73edfe8
Showing
21 changed files
with
872 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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,29 @@ | ||
version: 2.1 | ||
|
||
executors: | ||
ubuntu-build: | ||
description: "A regular build executor based on ubuntu image" | ||
docker: | ||
- image: envoyproxy/envoy-build:cfc514546bc0284536893cca5fa43d7128edcd35 | ||
# TODO(mattklein123): Get xlarge class enabled | ||
resource_class: medium | ||
working_directory: /source | ||
|
||
jobs: | ||
docs: | ||
executor: ubuntu-build | ||
steps: | ||
- checkout | ||
- run: git submodule update --init | ||
- run: docs/build.sh | ||
- store_artifacts: | ||
path: generated/docs | ||
|
||
workflows: | ||
version: 2 | ||
all: | ||
jobs: | ||
- docs: | ||
filters: | ||
tags: | ||
only: /^v.*/ |
This file contains 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,46 @@ | ||
# Configuration for probot-stale - https://github.com/probot/stale | ||
|
||
# General configuration | ||
# Label to use when marking as stale | ||
staleLabel: stale | ||
|
||
# Pull request specific configuration | ||
pulls: | ||
# Number of days of inactivity before an Issue or Pull Request becomes stale | ||
daysUntilStale: 7 | ||
# Number of days of inactivity before a stale Issue or Pull Request is closed. | ||
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale. | ||
daysUntilClose: 7 | ||
# Comment to post when marking as stale. Set to `false` to disable | ||
markComment: > | ||
This pull request has been automatically marked as stale because it has not had | ||
activity in the last 7 days. It will be closed in 7 days if no further activity occurs. Please | ||
feel free to give a status update now, ping for review, or re-open when it's ready. | ||
Thank you for your contributions! | ||
# Comment to post when closing a stale Issue or Pull Request. | ||
closeComment: > | ||
This pull request has been automatically closed because it has not had | ||
activity in the last 14 days. Please feel free to give a status update now, ping for review, or re-open when it's ready. | ||
Thank you for your contributions! | ||
# Limit the number of actions per hour, from 1-30. Default is 30 | ||
limitPerRun: 1 | ||
exemptLabels: | ||
- no stalebot | ||
|
||
# Issue specific configuration | ||
issues: | ||
# TODO: Consider increasing the limitPerRun once we are satisfied with the bot's performance | ||
limitPerRun: 1 | ||
daysUntilStale: 30 | ||
daysUntilClose: 7 | ||
markComment: > | ||
This issue has been automatically marked as stale because it has not had activity in the | ||
last 30 days. It will be closed in the next 7 days unless it is tagged "help wanted" or other activity | ||
occurs. Thank you for your contributions. | ||
closeComment: > | ||
This issue has been automatically closed because it has not had activity in the | ||
last 37 days. If this issue is still valid, please ping a maintainer and ask them to label it as "help wanted". | ||
Thank you for your contributions. | ||
exemptLabels: | ||
- help wanted | ||
- no stalebot |
This file contains 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,2 @@ | ||
build_docs/ | ||
generated/ |
This file contains 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,3 @@ | ||
[submodule "envoy"] | ||
path = envoy | ||
url = [email protected]:envoyproxy/envoy.git |
This file contains 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,4 @@ | ||
# Community Code of Conduct | ||
|
||
Envoy Mobile follows the | ||
[CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). |
This file contains 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,134 @@ | ||
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, Slack, | ||
email, etc. We will make sure no one else is already working on it and ask you to open a | ||
GitHub issue. | ||
* A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or | ||
changes any user-facing behavior. We will use the GitHub issue to discuss the feature and come to | ||
agreement. This is to prevent your time being wasted, as well as ours. The GitHub review process | ||
for major features is also important so that [organizations with commit access](OWNERS.md) can | ||
come to agreement on design. If it is appropriate to write a design document, the document must | ||
be hosted either in the GitHub tracking issue, or linked to from the issue and hosted in a | ||
world-readable location. | ||
* Small patches and bug fixes don't need prior communication. | ||
|
||
# Coding style | ||
|
||
* See [STYLE.md](STYLE.md) | ||
|
||
# Submitting a PR | ||
|
||
* TODO(mattklein123): Fill this in. | ||
|
||
# PR review policy for maintainers | ||
|
||
* Typically we try to turn around reviews within one business day. | ||
* See [OWNERS.md](OWNERS.md) for the current list of maintainers. | ||
* It is generally expected that a "domain expert" for the code the PR touches should review the | ||
PR. This person does not necessarily need to be a maintainer. | ||
* The above rule may be waived for PRs which only update docs or comments, or trivial changes to | ||
tests and tools (where trivial is decided by the maintainer in question). | ||
* If there is a question on who should review a PR please discuss in Slack. | ||
* Anyone is welcome to review any PR that they want, whether they are a maintainer or not. | ||
* Please **clean up the title and body** before merging. By default, GitHub fills the squash merge | ||
title with the original title, and the commit body with every individual commit from the PR. | ||
The maintainer doing the merge should make sure the title follows the guidelines above and should | ||
overwrite the body with the original extended description from the PR (cleaning it up if necessary) | ||
while preserving the PR author's final DCO sign-off. | ||
|
||
# DCO: Sign your work | ||
|
||
Envoy ships commit hooks that allow you to auto-generate the DCO signoff line if | ||
it doesn't exist when you run `git commit`. Simply navigate to the project | ||
root and run: | ||
|
||
```bash | ||
./scripts/setup_git_hooks.sh | ||
``` | ||
|
||
From here, simply commit as normal, and you will see the signoff at the bottom | ||
of each commit. | ||
|
||
The sign-off is a simple line at the end of the explanation for the | ||
patch, which certifies that you wrote it or otherwise have the right to | ||
pass it on as an open-source patch. The rules are pretty simple: if you | ||
can certify the below (from | ||
[developercertificate.org](https://developercertificate.org/)): | ||
|
||
``` | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
660 York Street, Suite 102, | ||
San Francisco, CA 94110 USA | ||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
Developer's Certificate of Origin 1.1 | ||
By making a contribution to this project, I certify that: | ||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. | ||
``` | ||
|
||
then you just add a line to every git commit message: | ||
|
||
Signed-off-by: Joe Smith <[email protected]> | ||
|
||
using your real name (sorry, no pseudonyms or anonymous contributions.) | ||
|
||
You can add the sign off when creating the git commit via `git commit -s`. | ||
|
||
If you want this to be automatic you can set up some aliases: | ||
|
||
```bash | ||
git config --add alias.amend "commit -s --amend" | ||
git config --add alias.c "commit -s" | ||
``` | ||
|
||
## Fixing DCO | ||
|
||
If your PR fails the DCO check, it's necessary to fix the entire commit history in the PR. Best | ||
practice is to [squash](https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) | ||
the commit history to a single commit, append the DCO sign-off as described above, and [force | ||
push](https://git-scm.com/docs/git-push#git-push---force). For example, if you have 2 commits in | ||
your history: | ||
|
||
```bash | ||
git rebase -i HEAD^^ | ||
(interactive squash + DCO append) | ||
git push origin -f | ||
``` | ||
|
||
Note, that in general rewriting history in this way is a hindrance to the review process and this | ||
should only be done to correct a DCO mistake. | ||
|
||
## Triggering CI re-run without making changes | ||
|
||
* TODO(mattklein123): Document when RepoKitteh is enabled. |
This file contains 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,37 @@ | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
1 Letterman Drive | ||
Suite D4700 | ||
San Francisco, CA, 94129 | ||
|
||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
|
||
|
||
Developer's Certificate of Origin 1.1 | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
|
||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
|
||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
|
||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. |
Oops, something went wrong.