forked from kubernetes/community
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
8 changed files
with
291 additions
and
95 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 |
|---|---|---|
| @@ -1,30 +1,70 @@ | ||
| ### How do I sign the CNCF CLA? | ||
| # The Contributor License Agreement | ||
|
|
||
| * To sign up as an individual or as an employee of a signed organization, go to https://identity.linuxfoundation.org/projects/cncf | ||
| * To sign up as an organization, go to https://identity.linuxfoundation.org/node/285/organization-signup | ||
| * To review the CNCF CLA, go to https://github.com/cncf/cla | ||
| The [Cloud Native Computing Foundation][CNCF] defines the legal status of the | ||
| contributed code in a _Contributor License Agreement_ (CLA). | ||
|
|
||
| *** | ||
| Only original source code from CLA signatories can be accepted into kubernetes. | ||
|
|
||
| ### After you select one of the options above, please follow the instructions below: | ||
| This policy does not apply to [third_party] and [vendor]. | ||
|
|
||
| **Step 1**: You must sign in with GitHub. | ||
| ## How do I sign? | ||
|
|
||
| **Step 2**: If you are signing up as an employee, you must use your official [email protected] email address in the CNCF account registration page. | ||
| #### 1. Read | ||
|
|
||
| * [CLA for individuals] to sign up as an individual or as an employee of a signed organization. | ||
| * [CLA for corporations] to sign as a corporation representative and manage signups from your organization. | ||
|
|
||
| #### 2. Sign in with GitHub. | ||
|
|
||
| **Step 3**: The email you use on your commits (https://help.github.com/articles/setting-your-email-in-git/) must match the email address you use when signing up for the CNCF account. | ||
| Click | ||
| * [Individual signup] to sign up as an individual or as an employee of a signed organization. | ||
| * [Corp signup] to sign as a corporation representative and manage signups from your organization. | ||
|
|
||
| Either signup form looks like this: | ||
|
|
||
|  | ||
|
|
||
| #### 3. Enter the correct E-mail address to validate! | ||
|
|
||
| The address entered on the form must meet two constraints: | ||
|
|
||
| * It __must match__ your [git email] (the output of `git config user.email`) | ||
| or your PRs will not be approved! | ||
|
|
||
| * It must be your official `[email protected]` address if you signed up | ||
| as an employee of said organization. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| #### 4. Look for an email indicating successful signup. | ||
|
|
||
| > The Linux Foundation | ||
| > | ||
| > Hello, | ||
| > | ||
| > You have signed CNCF Individual Contributor License Agreement. | ||
| > You can see your document anytime by clicking View on HelloSign. | ||
| > | ||
| **Step 4**: Once the CLA sent to your email address is signed (or your email address is verified in case your organization has signed the CLA), you should be able to check that you are authorized in any new PR you create. | ||
| Once you have this, the CLA authorizer bot will authorize your PRs. | ||
|
|
||
|  | ||
|
|
||
| **Step 5**: The status on your old PRs will be updated when any new comment is made on it. | ||
|
|
||
| ### I'm having issues with signing the CLA. | ||
| ## Troubleshooting | ||
|
|
||
| If you have signup trouble, please explain your case on | ||
| the [CLA signing issue] and we (@sarahnovotny and @foxish), | ||
| along with the [CNCF] will help sort it out. | ||
|
|
||
| Another option: ask for help at `[email protected]`. | ||
|
|
||
| If you're facing difficulty with signing the CNCF CLA, please explain your case on https://github.com/kubernetes/kubernetes/issues/27796 and we (@sarahnovotny and @foxish), along with the CNCF will help sort it out. | ||
| [CNCF]: https://www.cncf.io/community | ||
| [CLA signing issue]: https://github.com/kubernetes/kubernetes/issues/27796 | ||
| [CLA for individuals]: https://github.com/cncf/cla/blob/master/individual-cla.pdf | ||
| [CLA for corporations]: https://github.com/cncf/cla/blob/master/corporate-cla.pdf | ||
| [Corp signup]: https://identity.linuxfoundation.org/node/285/organization-signup | ||
| [Individual signup]: https://identity.linuxfoundation.org/projects/cncf | ||
| [git email]: https://help.github.com/articles/setting-your-email-in-git | ||
| [third_party]: https://github.com/kubernetes/kubernetes/tree/master/third_party | ||
| [vendor]: https://github.com/kubernetes/kubernetes/tree/master/vendor |
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 |
|---|---|---|
| @@ -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. | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.