Adds Contrib Doc #27
Adds Contrib Doc #27
Conversation
CONTRIBUTING.md
Outdated
| * It is generally expected that a maintainer representing a different organization from the PR owner | ||
| is required to review the PR. |
There was a problem hiding this comment.
@LukeShu @youngnick note that this topic was discussed during a community meeting.
There was a problem hiding this comment.
I would use even stronger language and make it a requirement instead of a "general expectation". Perhaps we should also use the term "affiliation" rather than "organization" to distinguish it from GitHub orgs.
There was a problem hiding this comment.
See my response in #27 (comment)
|
@LukeShu I would like all 3 organizations to review PRs during the early stages of the project, so PTAL and merge if all looks good to you. |
|
|
||
| ## Communication | ||
|
|
||
| * Before starting work on a major feature, please contact us via GitHub or Slack. We will ensure no |
There was a problem hiding this comment.
We should provide links to GitHub and Slack as soon as the project and channels are made public.
There was a problem hiding this comment.
Yes, they will be added to the readme, xref.
| build. If your PR cannot have 100% coverage for some reason please clearly explain why when you | ||
| open it. | ||
| * Any PR that changes user-facing behavior **must** have associated documentation in [docs](docs) as | ||
| well as the [changelog](CHANGELOG.md). |
There was a problem hiding this comment.
CHANGELOG.md doesn't exist yet.
xref: #54
There was a problem hiding this comment.
Thanks for creating the issue!
CONTRIBUTING.md
Outdated
| * When all tests are passing and all other conditions described herein are satisfied, a maintainer | ||
| will be assigned to review and merge the PR. | ||
| * Once you submit a PR, *please do not rebase it*. It's much easier to review if subsequent commits | ||
| are new commits and/or merges. We squash rebase the final merged commit so the number of commits |
There was a problem hiding this comment.
We should change the repository's configuration to make "Squash and merge" the default.
CONTRIBUTING.md
Outdated
| * It is generally expected that a maintainer representing a different organization from the PR owner | ||
| is required to review the PR. |
There was a problem hiding this comment.
I would use even stronger language and make it a requirement instead of a "general expectation". Perhaps we should also use the term "affiliation" rather than "organization" to distinguish it from GitHub orgs.
I will update to use "affiliation" instead of "organization". I use "general expectation" due to the following caveat:
I have updated this bullet to clearly state this is required, PTAL. |
danehans
force-pushed
the
issue_8
branch
2 times, most recently
from
40777da
to
1163c07
Compare
Signed-off-by: danehans <daneyonhansen@gmail.com>
Signed-off-by: danehans <daneyonhansen@gmail.com>
Signed-off-by: danehans <daneyonhansen@gmail.com>
|
Had to rebase. PTAL and /approve if all looks good. |
Adds a contrib doc based on Envoy and go-control-plane.
Fixes: #8
Signed-off-by: danehans daneyonhansen@gmail.com