Skip to content
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

Contributor guide folder and central starting point README outline #1409

Merged
merged 10 commits into from Nov 20, 2017

Conversation

guineveresaenger
Copy link
Contributor

This is the starting point for creating a single source of truth for how to contribute to Kubernetes.

A follow-up umbrella issue will be filed that contains a list of tasks that need to be completed to fully migrate all the information to a central source of truth.

The README itself contains references to tasks that are still outstanding, but it would be helpful to have it merged into master, so we have somewhere to point people, to make them aware this is being worked on, and perhaps to garner more help.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 16, 2017
@castrojo
Copy link
Member

/sig contribex

@cblecker
Copy link
Member

/ok-to-test
/cc
/sig contributor-experience

Will review this :)

@k8s-ci-robot k8s-ci-robot added sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 16, 2017
Copy link
Member

@idvoretskyi idvoretskyi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good as the foundation, please fix the minor issues after my comments.


Kubernetes is the main focus of CloudNativeCon/KubeCon, held every spring in Europe and winter in North America. Information about these and other community events is available on the CNCF [events](https://www.cncf.io/events/) pages.

### Meetups
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, leave as is, I'll update after merging.

* include link to meetups
* information on CNCF support for founding a Meetup

### Kubecon
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KubeCon


## Events

Kubernetes is the main focus of CloudNativeCon/KubeCon, held every spring in Europe and winter in North America. Information about these and other community events is available on the CNCF [events](https://www.cncf.io/events/) pages.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kubernetes is the main focus of CloudNativeCon/KubeCon, held twice per year in EMEA and in North America. Information about these and other community events is available on the CNCF events pages.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edited. We don't necessarily run KubeCon only in winter and spring. Also, not necessarily Europe (but EMEA).

@@ -0,0 +1,212 @@
**OWNER:**

SIG-ContribX
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: sig-contributor-experience

SIG-ContribX


# WARNING
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting a new contributor document with an H1 WARNING isn't super friendly. Perhaps say this is a disclaimer?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1


Many of the links below should lead to relevant documents scattered across the community repository. Often, the linked instructions need to be updated or cleaned up.

* If you do so, please port the relevant file from its previous location to come live in the community/contributors/guide folder, and delete its previous location.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: s/port/{move|relocate}/ -- easier to understand, especially with newer english speakers

Many of the links below should lead to relevant documents scattered across the community repository. Often, the linked instructions need to be updated or cleaned up.

* If you do so, please port the relevant file from its previous location to come live in the community/contributors/guide folder, and delete its previous location.
* Ultimately, all contributor guide specific files will live in this folder.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: s/Ultimately/Our goal is/ -- more open tone as it conveys that we're a big team and inviting people to become a part of it


## Sign the CLA

Before you can contribute, you will need to sign the [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relative links work, and help when you're working in a fork or branch. So something like /CLA.md in this markdown file should link to the right place. You can do a find/replace for anything https://github.com/kubernetes/community/blob/master/ or https://github.com/kubernetes/community/tree/master/ and subsitute it with /.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd keep the full path if this document will be moved somewhere.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, if the goal is to move this out of community, then I agree.

In that case, I’d suggest https://git.k8s.io/community/CLA.md (and similar). That’s a redirect we own and provides for a clean, consistent anchor for fully qualified URLs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh. I was unaware of those. Do all kubernetes github files have such a redirect?

And yes, relative files +1, but after we move them into the /guide folder, which in the case of CLA we should.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git.k8s.io is just an nginx redirector.. code is here: https://github.com/kubernetes/k8s.io/blob/8320db3841550deb6084137e0533fdc8c193d9b7/k8s.io/configmap-nginx.yaml#L183-L193

and yes, it works for any github.com/kubernetes/ repo


### Meetups

__Improvements needed_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the two underscores here mess up the formatting a bit.


_Improvements needed_
* edit above link to only provide code review section.
* decide whether this is something that belongs in this section, or should be combined with Contributing instructions [below](https://github.com/guineveresaenger/community/tree/contributor-guide/contributors/guide#contributing).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links to a personal repo, per above, this should be a relative link (e.g. /contributor-guide/contributors/guide#contributing)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops


* Possible text to elaborate on (the sig list should remain in its current place however):

* ([Pick a SIG](https://github.com/kubernetes/community/blob/master/sig-list.md), peruse its associated [cmd](https://github.com/kubernetes/kubernetes/tree/master/cmd) directory, find a main() and read code until you find something you want to fix.)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git.k8s.io/kubernetes/master/cmd

@guineveresaenger
Copy link
Contributor Author

Thank you @cblecker I will update tomorrow PST :)

@guineveresaenger
Copy link
Contributor Author

Apologies @cblecker - got a bit swamped on Friday afternoon. All changes should be addressed now.

@stp-ip
Copy link
Member

stp-ip commented Nov 20, 2017

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 20, 2017
@k8s-github-robot
Copy link

/test all [submit-queue is verifying that this PR is safe to merge]

@k8s-github-robot
Copy link

Automatic merge from submit-queue.

@k8s-github-robot k8s-github-robot merged commit 02bff92 into kubernetes:master Nov 20, 2017
@guineveresaenger guineveresaenger deleted the contributor-guide branch November 20, 2017 18:13
@cblecker
Copy link
Member

@stp-ip @guineveresaenger In future, we should be squashing before merge (to keep the tree at least somewhat clean)

@stp-ip
Copy link
Member

stp-ip commented Nov 20, 2017

@cblecker Yes missed that. Was checking the whole content and if all comments were addressed. Sorry my fault.

@guineveresaenger
Copy link
Contributor Author

@cblecker in kubernetes do we "squash and merge" or do we squash before submitting PR/force-push with altered history in case of changes?

@guineveresaenger
Copy link
Contributor Author

(I had assumed the former)

@cblecker
Copy link
Member

The latter. The actual merge is handled by a bot, and just does a straight git merge

@cblecker
Copy link
Member

Having split up commits helps from a review standpoint, but then once all comments are addressed, usually the last step is the author squashing into a readable git history

@guineveresaenger
Copy link
Contributor Author

Makes sense. Thank you for your patience. makes mental note to go through that part of this very documentation with a fine comb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants