Skip to content

Commit

Permalink
Update references to help wanted label
Browse files Browse the repository at this point in the history
  • Loading branch information
cblecker committed Dec 22, 2017
1 parent 19d1097 commit ce3044d
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 31 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ For more specific topics, try a SIG.
## SIGs

Kubernetes is a set of projects, each shepherded by a special interest group (SIG).

A first step to contributing is to pick from the [list of kubernetes SIGs](sig-list.md).

A SIG can have its own policy for contribution,
A SIG can have its own policy for contribution,
described in a `README` or `CONTRIBUTING` file in the SIG
folder in this repo (e.g. [sig-cli/CONTRIBUTING](sig-cli/CONTRIBUTING.md)),
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),
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?
Expand All @@ -31,7 +31,7 @@ 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.
that should not need deep knowledge of the system.

To dig deeper, read a design doc, e.g. [architecture].

Expand All @@ -55,14 +55,14 @@ lead to many relevant topics, including
## Your First Contribution

We recommend that you work on an existing issue before attempting
to [develop a new feature].
to [develop a new feature].

Start by finding an existing issue with the [help wanted] label;
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,
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.
issue thread expressing interest in working on it.

This helps other people know that the issue is active, and
hopefully prevents duplicated efforts.

Expand All @@ -85,8 +85,7 @@ If you want to work on a new idea of relatively small scope:
[Developer's Guide]: contributors/devel/development.md
[develop a new feature]: https://github.com/kubernetes/features
[expectations]: contributors/devel/community-expectations.md
[help wanted]: https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3A%22help%20wanted%22
[help wanted]: https://go.k8s.io/help-wanted
[pull request]: contributors/devel/pull-requests.md

[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/CONTRIBUTING.md?pixel)]()

29 changes: 14 additions & 15 deletions contributors/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sig-contributor-experience
## Disclaimer
Hello! This is the starting point for our brand new contributor guide, currently underway as per [issue#6102](https://github.com/kubernetes/website/issues/6102) and in need of help. Please be patient, or fix a section below that needs improvement, and submit a pull request!

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.
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 move the relevant file from its previous location to the community/contributors/guide folder, and delete its previous location.
* Our goal is that all contributor guide specific files live in this folder.
Expand All @@ -17,9 +17,9 @@ For example:
_Improvements needed_
* kubernetes/kubernetes/contributing.md -> point to this guide

* kubernetes/community/CONTRIBUTING.md -> Needs a rewrite
* kubernetes/community/CONTRIBUTING.md -> Needs a rewrite

* kubernetes/community/README.md -> Needs a rewrite
* kubernetes/community/README.md -> Needs a rewrite

* Individual SIG contributing documents -> add a link to this guide

Expand Down Expand Up @@ -69,7 +69,7 @@ _Improvements needed_

* RyanJ from Red Hat is working on this

## Community Expectations
## Community Expectations

Kubernetes is a community project. Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.

Expand Down Expand Up @@ -99,7 +99,7 @@ You get the idea - if you ever see something you think should be fixed, you shou
### Find a good first topic

There are multiple repositories within the Kubernetes community and a full list of repositories can be found [here](https://github.com/kubernetes/).
Each repository in the Kubernetes organization has beginner-friendly issues that provide a good first issue. For example, [kubernetes/kubernetes](https://git.k8s.io/kubernetes) has [help-wanted issues](https://issues.k8s.io/?q=is%3Aopen+is%3Aissue+label%3A%22help%20wanted%22) that should not need deep knowledge of the system.
Each repository in the Kubernetes organization has beginner-friendly issues that provide a good first issue. For example, [kubernetes/kubernetes](https://git.k8s.io/kubernetes) has [help wanted issues](https://go.k8s.io/help-wanted) that should not need deep knowledge of the system.
Another good strategy is to find a documentation improvement, such as a missing/broken link, which will give you exposure to the code submission/review process without the added complication of technical depth. Please see [Contributing](#Contributing) below for the workflow.

### Learn about SIGs
Expand All @@ -111,31 +111,31 @@ SIGs also have their own CONTRIBUTING.md files, which may contain extra informat

Like everything else in Kubernetes, a SIG is an open, community, effort. Anybody is welcome to jump into a SIG and begin fixing issues, critiquing design proposals and reviewing code. SIGs have regular [video meetings](https://kubernetes.io/community/) which everyone is welcome to. Each SIG has a kubernetes slack channel that you can join as well.

There is an entire SIG ([sig-contributor-experience](../../sig-contributor-experience/README.md)) devoted to improving your experience as a contributor.
There is an entire SIG ([sig-contributor-experience](../../sig-contributor-experience/README.md)) devoted to improving your experience as a contributor.
Contributing to Kubernetes should be easy. If you find a rough edge, let us know! Better yet, help us fix it by joining the SIG; just
show up to one of the [bi-weekly meetings](https://docs.google.com/document/d/1qf-02B7EOrItQgwXFxgqZ5qjW0mtfu5qkYIF1Hl4ZLI/edit).

#### Find a SIG that is related to your contribution

Finding the appropriate SIG for your contribution will help you ask questions in the correct place and give your contribution higher visibility and a faster community response.

For Pull Requests, the automatically assigned reviewer will add a SIG label if you haven't done so. See [Open A Pull Request](#open-a-pull-request) below.
For Pull Requests, the automatically assigned reviewer will add a SIG label if you haven't done so. See [Open A Pull Request](#open-a-pull-request) below.

For Issues we are still working on a more automated workflow. Since SIGs do not directly map onto Kubernetes subrepositories, it may be difficult to find which SIG your contribution belongs in. Here is the [list of SIGs](/sig-list.md). Determine which is most likely related to your contribution.
For Issues we are still working on a more automated workflow. Since SIGs do not directly map onto Kubernetes subrepositories, it may be difficult to find which SIG your contribution belongs in. Here is the [list of SIGs](/sig-list.md). Determine which is most likely related to your contribution.

*Example:* if you are filing a cni issue, you should choose SIG-networking.
*Example:* if you are filing a cni issue, you should choose SIG-networking.

Follow the link in the SIG name column to reach each SIGs README. Most SIGs will have a set of GitHub Teams with tags that can be mentioned in a comment on issues and pull requests for higher visibility. If you are not sure about the correct SIG for an issue, you can try SIG-contributor-experience [here](/sig-contributor-experience#github-teams), or [ask in Slack](http://slack.k8s.io/).

_Improvements needed_
_Improvements needed_

* Open pull requests with all applicable SIGs to not have duplicate information in their CONTRIBUTING.md and instead link here. Keep it light, keep it clean, have only one source of truth.
* Open pull requests with all applicable SIGs to not have duplicate information in their CONTRIBUTING.md and instead link here. Keep it light, keep it clean, have only one source of truth.

### File an Issue

Not ready to contribute code, but see something that needs work? While the community encourages everyone to contribute code, it is also appreciated when someone reports an issue (aka problem). Issues should be filed under the appropriate Kubernetes subrepository.
Not ready to contribute code, but see something that needs work? While the community encourages everyone to contribute code, it is also appreciated when someone reports an issue (aka problem). Issues should be filed under the appropriate Kubernetes subrepository.

*Example:* a documentation issue should be opened to [kubernetes/website](https://github.com/kubernetes/website/issues).
*Example:* a documentation issue should be opened to [kubernetes/website](https://github.com/kubernetes/website/issues).

Make sure to adhere to the prompted submission guidelines while opening an issue.

Expand All @@ -159,7 +159,7 @@ For questions and troubleshooting, please feel free to use any of the methods of

To check out code to work on, please refer to [this guide](/contributors/devel/development.md#workflow).

_Improvements needed_
_Improvements needed_

* move github workflow into its own file in this folder.

Expand Down Expand Up @@ -251,4 +251,3 @@ _Improvements needed_

_Improvements needed_
* Link and mini description for Kubernetes Pilots should go here.

6 changes: 3 additions & 3 deletions sig-cli/outreachy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Outreachy

Kubernetes, specifically the SIG-CLI, is happy to announce our participation in the Outreachy program, running from December 2017 to March 2018.
Kubernetes, specifically the SIG-CLI, is happy to announce our participation in the Outreachy program, running from December 2017 to March 2018.
Please see the [main program page](https://www.outreachy.org/) for the general information about the program,
such as its purpose, timeline, eligibility requirements, and how to apply.

Expand Down Expand Up @@ -37,9 +37,9 @@ Similar to contacting the coordinators, the mentors can be contacted at any time
As part of the application process, the Outreachy program recommends that candidates make small contributions to the project they intend to apply for.
To start working on the project, make sure to fill out the CLA and check if you have the right environment with this guide. The README in the [community repo](https://github.com/kubernetes/community) details these things and more.

Check out these specific resources for how to contribute to CLI:
Check out these specific resources for how to contribute to CLI:
* SIG-CLI - [How to Contribute](https://github.com/kubernetes/community/blob/master/sig-cli/CONTRIBUTING.md)
* Filter issue search for: `is:open is:issue label:sig/cli label:help-wanted` (or `label:for-new-contributors`)
* Filter issue search for: `is:open is:issue label:sig/cli label:"help wanted"`
* Hand picked issues for outreachy applications: https://github.com/kubernetes/kubectl/projects/3

## Available tasks
Expand Down
4 changes: 2 additions & 2 deletions sig-multicluster/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ New contributors can try the following to work on an existing bug or approved de
1. An [issue] is filed that
- includes steps to reproduce the issue including client / server version,
- mentions `@kubernetes/sig-multicluster-bugs`.

#### Sending a fix

2. A [PR] fixing the issue is implemented that
Expand Down Expand Up @@ -280,7 +280,7 @@ See the sig-multicluster [community page] for points of contact and meeting time
[feature]: https://github.com/kubernetes/features
[group]: https://groups.google.com/forum/#!forum/kubernetes-sig-multicluster
[issue]: https://github.com/kubernetes/kubernetes/issues
[multicluster_help_wanted_issues]: https://github.com/kubernetes/kubernetes/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3Ahelp-wanted%20label%3Asig%2Fmulticluster
[multicluster_help_wanted_issues]: https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted"+label%3Asig%2Fmulticluster
[kubectl concept docs]: https://github.com/kubernetes/kubernetes.github.io/tree/master/docs/concepts/tools/kubectl
[kubectl docs]: https://kubernetes.io/docs/user-guide/kubectl-overview
[kubernetes/cmd/kubectl]: https://github.com/kubernetes/kubernetes/tree/master/cmd/kubectl
Expand Down

0 comments on commit ce3044d

Please sign in to comment.