diff options
| author | Jeffrey Regan <jregan@google.com> | 2017-03-03 15:09:16 -0800 |
|---|---|---|
| committer | Jeffrey Regan <jregan@google.com> | 2017-03-06 16:28:38 -0800 |
| commit | df2d85634233dbf8ae154c29cf164eebba89eff5 (patch) | |
| tree | bda41a543ff3deb21cf2c2fdc1a4bf2c8442fcec /CONTRIBUTING.md | |
| parent | 6e0b059838a365de143a6a7e95d0ea96be75e7c7 (diff) | |
Close #420
General theme:
* Move remaining community stuff out of kubernetes/kubernetes.
* Put self-contained things into their own MD files.
* Point to those files rather than repeat their content.
* Make all docs smaller, but more of them.
See companion PR in kubernetes/kubernetes
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 36 |
1 files changed, 25 insertions, 11 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00591970..8dc16c3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,30 @@ -# Contributing guidelines +# Contributing to the community repo -This project is for documentation about the community. To contribute to one of -the Kubernetes projects please see the contribution guide for that project. -## How To Contribute +Contributions to this community repository follow a +[pull request](https://help.github.com/articles/using-pull-requests/) (PR) +model: -The contributions here follow a [pull request](https://help.github.com/articles/using-pull-requests/) model with some additional process. -The process is as follows: +#### 1. Submit a PR with your change -1. Submit a pull request with the requested change. -2. Another person, other than a Special Interest Group (SIG) owner, can mark it Looks Good To Me (LGTM) upon successful review. Otherwise feedback can be given. -3. A SIG owner can merge someone else's change into their SIG documentation immediate. -4. Someone cannot immediately merge their own change. To merge your own change wait 24 hours during the week or 72 hours over a weekend. This allows others the opportunity to review a change. +#### 2. Get an LGTM. -_Note, the SIG Owners decide on the layout for their own sub-directory structure._ +Upon successful review, someone will give the PR +a __LGTM__ (_looks good to me_) in the review thread. + +#### 3. Allow time for others to see it + +Once you have an __LGTM__, please wait 24 hours during +the week or 72 hours over a weekend before you +merge it, to give others (besides your initial reviewer) +time to see it. + +__That said, a [SIG lead](sig-list.md) may shortcut this by merging +someone else's change into their SIG's documentation +at any time.__ + +Edits in SIG sub-directories should follow structure and guidelines set +by the respective SIG leads - see `CONTRIBUTING` instructions in subdirectories. + + +
\ No newline at end of file |