From 7c0b13213c7f5285ec8affd5585add817b7768cd Mon Sep 17 00:00:00 2001 From: guineveresaenger Date: Thu, 15 Feb 2018 14:47:48 -0800 Subject: Scrub of the main K8s community README We created a comprehensive contributor guide, which affects the main message of the top-level README.md. This commit removes duplicate or outdated information and instead links to /contributors/guide/README. --- README.md | 57 ++++++++++++++++++--------------------------------------- 1 file changed, 18 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index f8eed62e..729a32a1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Welcome to the Kubernetes community! -This is the starting point for becoming a contributor - improving docs, improving code, giving talks etc. +This is the starting point for joining and contributing to the Kubernetes community - improving docs, improving code, giving talks etc. ## Communicating @@ -30,61 +30,40 @@ please follow [these instructions](./generator) that detail how our docs are aut Documentation (like the text you are reading now) can always use improvement! -There's a [semi-curated list of issues][help wanted] -that should not need deep knowledge of the system. +Each [kubernetes project](http://git.k8s.io) subrepository (including this one!) has issues that are labeled "help-wanted", "good first issue" or similar that should not need deep knowledge of the system. For example, here are [help wanted] issues for the main Kubernetes repository. To dig deeper, read a design doc, e.g. [architecture]. [Pick a SIG](sig-list.md), peruse its associated [cmd] directory, find a `main()` and read code until you find something you want to fix. -There's always code that can be clarified and variables -or functions that can be renamed or commented. - -There's always a need for more test coverage. - ## Learn to Build Links in [contributors/devel/README.md](contributors/devel/README.md) -lead to many relevant topics, including - * [Developer's Guide] - how to start a build/test cycle - * [Collaboration Guide] - how to work together - * [Expectations] - what the community expects - * [Pull Request Process] - how to prepare a pull request - -## Your First Contribution - -We recommend that you work on an existing issue before attempting -to [develop a new feature]. +lead to many relevant technical topics. -Start by finding an existing issue with the [help wanted] label; -these issues we've deemed are well suited for new contributors. -Alternatively, if there is a specific area you are interested in, -ask a [SIG lead](sig-list.md) for suggestions), and respond on the -issue thread expressing interest in working on it. +## Contributing -This helps other people know that the issue is active, and -hopefully prevents duplicated efforts. - -Before submitting a pull request, sign the [CLA]. - -If you want to work on a new idea of relatively small scope: - - 1. Submit an issue describing your proposed change to the repo in question. - 1. The repo owners will respond to your issue promptly. - 1. If your proposed change is accepted, - sign the [CLA], - and start work in your fork. - 1. Submit a [pull request] containing a tested change. +The [Contributor Guide](contributors/guide/README.md) provides detailed instruction on how to get your ideas and bug fixes seen and accepted, including: +1. How to [file an issue] +1. How to [find something to work on] +1. How to [open a pull request] [architecture]: /contributors/design-proposals/architecture/architecture.md [cmd]: https://git.k8s.io/kubernetes/cmd -[CLA]: CLA.md -[Collaboration Guide]: contributors/devel/collab.md +[kubernetes project]:http://git.k8s.io [Developer's Guide]: contributors/devel/development.md +[Contributor Guide]: +contributors/guide/README.md +[file an issue]: +/contributors/guide/README.md#file-an-issue +[find something to work on]: +contributors/guide/README.md#find-something-to-work-on +[open a pull request]: +contributors/guide/README.md#open-a-pull-request [develop a new feature]: https://github.com/kubernetes/features -[expectations]: contributors/guide/community-expectations.md + [help wanted]: https://go.k8s.io/help-wanted [pull request]: contributors/devel/pull-requests.md -- cgit v1.2.3 From ec67b5f11e993d73cad3420abed0313e5aa9abf8 Mon Sep 17 00:00:00 2001 From: guineveresaenger Date: Thu, 15 Feb 2018 14:55:05 -0800 Subject: Community Readme: add membership information The Community repository is where we attract and support new members, and grow contributors into climbing the membership ladder. This provides information and links to community-membership.md. --- README.md | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 729a32a1..b67f93f2 100644 --- a/README.md +++ b/README.md @@ -25,34 +25,22 @@ and its own mailing list, slack channel, etc. If you want to edit details about a SIG (e.g. its weekly meeting time or its leads), please follow [these instructions](./generator) that detail how our docs are auto-generated. -## How Can I Help? - -Documentation (like the text you are reading now) can -always use improvement! - -Each [kubernetes project](http://git.k8s.io) subrepository (including this one!) has issues that are labeled "help-wanted", "good first issue" or similar that should not need deep knowledge of the system. For example, here are [help wanted] issues for the main Kubernetes repository. - -To dig deeper, read a design doc, e.g. [architecture]. - -[Pick a SIG](sig-list.md), peruse its associated [cmd] directory, -find a `main()` and read code until you find something you want to fix. - ## Learn to Build Links in [contributors/devel/README.md](contributors/devel/README.md) lead to many relevant technical topics. -## Contributing +## Contribute The [Contributor Guide](contributors/guide/README.md) provides detailed instruction on how to get your ideas and bug fixes seen and accepted, including: 1. How to [file an issue] 1. How to [find something to work on] 1. How to [open a pull request] +## Membership + +We encourage all contributors to become members. We aim to grow an active, healthy community of contributors, reviewers, and code owners. Learn more about requirements and responsibilities of memebership in our [Community Membership] page. -[architecture]: /contributors/design-proposals/architecture/architecture.md -[cmd]: https://git.k8s.io/kubernetes/cmd -[kubernetes project]:http://git.k8s.io [Developer's Guide]: contributors/devel/development.md [Contributor Guide]: contributors/guide/README.md @@ -62,9 +50,6 @@ contributors/guide/README.md contributors/guide/README.md#find-something-to-work-on [open a pull request]: contributors/guide/README.md#open-a-pull-request -[develop a new feature]: https://github.com/kubernetes/features - -[help wanted]: https://go.k8s.io/help-wanted -[pull request]: contributors/devel/pull-requests.md +[Community Membership]:/community-membership.md [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/CONTRIBUTING.md?pixel)]() -- cgit v1.2.3 From 143a71ef7359fb7bc9924f1e7ced1bc1e4eb8635 Mon Sep 17 00:00:00 2001 From: guineveresaenger Date: Thu, 15 Feb 2018 15:04:41 -0800 Subject: Adds link to project governance We as a project have a certain structure, and this commit will link to governance.md from the top-level README so that users can learn about the project governance. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index b67f93f2..16a597e2 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Welcome to the Kubernetes community! This is the starting point for joining and contributing to the Kubernetes community - improving docs, improving code, giving talks etc. +To learn more about the project structure and organization, please refer to [Project Governance] information. + ## Communicating The [communication](communication.md) page lists communication channels like chat, @@ -41,6 +43,7 @@ The [Contributor Guide](contributors/guide/README.md) provides detailed instruct We encourage all contributors to become members. We aim to grow an active, healthy community of contributors, reviewers, and code owners. Learn more about requirements and responsibilities of memebership in our [Community Membership] page. +[Project Governance]:/governance.md [Developer's Guide]: contributors/devel/development.md [Contributor Guide]: contributors/guide/README.md -- cgit v1.2.3