You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* contrib-guide: apply styleguide to first-contribution page
* Continuing updates to your first contribution page
Continuing updates to your-first-contribution page to align with style guide
* Update first-contribution.md
Resolved suggested changes to your-first-contribution page
* Update first-contribution.md
Continued making changes to your-first-contribution to align with Kubernetes Developer Style guide per suggested changes
* Update first-contribution.md
Updated your-first-contribution page to resolve suggested changes
Copy file name to clipboardExpand all lines: contributors/guide/first-contribution.md
+96-45Lines changed: 96 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,70 +19,98 @@ description: |
19
19
20
20
## Find something to work on
21
21
22
-
Help is always welcome! For example, documentation (like the text you are reading now) can always use improvement.
23
-
There's always code that can be clarified and variables or functions that can be renamed or commented.
24
-
There's always a need for more test coverage.
25
-
You get the idea - if you ever see something you think should be fixed, you should own it.
26
-
Here is how you get started.
27
-
If you have no idea what to start on, you can browse the [Contributor Role Board](https://discuss.kubernetes.io/c/contributors/role-board) to see who is looking for help.
28
-
Those interested in contributing without writing code may also find ideas in the [Non-Code Contributions Guide](non-code-contributions.md).
22
+
The first step to getting starting contributing to Kubernetes is to find something
23
+
to work on. Help is always welcome, and no contribution is too small!
24
+
25
+
Here are some things you can do today to get started contributing:
26
+
27
+
* Help improve the Kubernetes documentation
28
+
* Clarify code, variables, or functions that can be renamed or commented on
29
+
* Write test coverage
30
+
* Help triage issues
31
+
32
+
If the above suggestions don't appeal to you, you can browse the
33
+
[Contributor Role Board] to see who is looking for help. Those interested
34
+
in contributing without writing code can also find ideas in the
35
+
[Non-Code Contributions Guide].
29
36
30
37
### Find a good first topic
31
38
32
-
There are [multiple repositories](https://github.com/kubernetes/) within the Kubernetes organization.
33
-
Each repository has beginner-friendly issues that provide a good first issue.
34
-
For example, [kubernetes/kubernetes](https://git.k8s.io/kubernetes) has [help wanted](https://go.k8s.io/help-wanted) and [good first issue](https://go.k8s.io/good-first-issue) labels for issues that should not need deep knowledge of the system.
35
-
The `good first issue` label indicates that members have committed to providing [extra assistance](/contributors/guide/help-wanted.md) for new contributors.
39
+
There are [multiple repositories] within the Kubernetes organization.
40
+
Each repository has beginner-friendly issues that are a great place to
41
+
get started on your contributor journey. For example, [kubernetes/kubernetes] has
42
+
[help wanted] and [good first issue] labels for issues that don't need high-level
43
+
Kubernetes knowledge to contribute to. The `good first issue` label also indicates
44
+
that Kubernetes Members have committed to providing [extra assistance] for new
45
+
contributors. Another way to get started is to find a documentation improvement,
46
+
such as a missing/broken link, which will give you exposure to the code
47
+
submission/review process without the added complication of technical depth.
36
48
37
-
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.
49
+
### Issue Assignment in Github
38
50
39
-
#### Issue Assignment in Github
51
+
When you've found an issue to work on, you can assign it to yourself.
40
52
41
-
When you are willing to take on an issue, you can assign it to yourself. Just reply with `/assign` or `/assign @yourself` on an issue,
42
-
then the robot will assign the issue to you and your name will present at `Assignees` list.
53
+
* Reply with `/assign` or `/assign @yourself` on the issue you'd like to work on
54
+
* The [K8s-ci-robot] will automatically assign the issue to you.
55
+
* Your your name will then be listed under, `Assignees`.
43
56
44
-
###Learn about SIGs
57
+
## Learn about SIGs
45
58
46
-
You may have noticed that some repositories in the Kubernetes Organization are owned by [Special Interest Groups](/sig-list.md), or SIGs.
47
-
We organize the community into SIGs in order to improve our workflow and more easily manage what is a very large community project.
48
-
The developers within each SIG have autonomy and ownership over that SIG's part of Kubernetes. Check out the [list of SIGs](/sig-list.md) for contact information.
59
+
Some repositories in the Kubernetes Organization are owned by
60
+
[Special Interest Groups], or SIGs.
49
61
50
-
Understanding how to interact with SIGs is an important part of contributing.
62
+
The Kubernetes community is broken out into SIGs in order to improve its workflow,
63
+
and more easily manage what is a very large community project. The developers
64
+
within each SIG have autonomy and ownership over that SIG's part of Kubernetes.
65
+
Understanding how to interact with SIGs is an important part of contributing
66
+
to Kubernetes. Check out the [list of SIGs][sl] for contact information.
51
67
52
-
####SIG structure
68
+
### SIG structure
53
69
54
70
A SIG is an open, community effort.
55
-
Anybody is welcome to jump into a SIG and begin fixing issues, critiquing design proposals and reviewing code.
56
-
SIGs have regular [video meetings](https://kubernetes.io/community/) which everyone is welcome to.
57
-
Each SIG has a slack channel, meeting notes, and their own documentation that is useful to read and understand.
58
71
59
-
There is an entire SIG ([sig-contributor-experience](/sig-contributor-experience/README.md)) devoted to improving your experience as a contributor.
60
-
Contributing to Kubernetes should be easy.
61
-
If you find a rough edge, let us know! Better yet, help us fix it by joining the SIG; just
62
-
show up to one of the [bi-weekly meetings](https://docs.google.com/document/d/1qf-02B7EOrItQgwXFxgqZ5qjW0mtfu5qkYIF1Hl4ZLI/edit).
72
+
Anybody is welcome to jump into a SIG and begin fixing issues, critiqe design
73
+
proposals, and review code. SIGs have regular [video meetings] which everyone
74
+
is welcome to attend. Each SIG has a Slack channel, meeting notes, and their own
75
+
documentation that is useful to read and understand. There is an entire SIG
76
+
([sig-contributor-experience]) devoted to improving your experience as a contributor.
77
+
If you have an idea for improving the contributor experience, please consider
78
+
attending one of the Contributor Experience SIG's [weekly meetings].
63
79
64
-
####Find a SIG that is related to your contribution
80
+
### Find a SIG that is related to your contribution
65
81
66
-
Finding the appropriate SIG for your contribution and adding a SIG label will help you ask questions in the correct place and give your contribution higher visibility and a faster community response.
82
+
Finding the appropriate SIG for your contribution and adding a SIG label will
83
+
help you ask questions in the correct place and give your contribution higher
84
+
visibility and a faster community response.
67
85
68
-
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.
86
+
For Pull Requests, the automatically assigned reviewer will add a SIG label
87
+
if you haven't already done so.
69
88
70
-
For Issues, we are still working on a more automated workflow.
71
-
Since SIGs do not directly map onto Kubernetes subrepositories, it may be difficult to find which SIG your contribution belongs in.
72
-
Here is the [list of SIGs](/sig-list.md) so that you can determine which is most likely related to your contribution.
89
+
For Issues, please note that the community is working on a more automated workflow.
90
+
Since SIGs do not directly map onto Kubernetes subrepositories, it may be
91
+
difficult to find which SIG your contribution belongs in. Review the
92
+
[list of SIGs][sl] to determine which SIG is most likely related to your
93
+
contribution.
73
94
74
-
*Example:* if you are filing a CNI issue (that's [Container Networking Interface](https://github.com/containernetworking/cni)), you should choose the [Network SIG](http://git.k8s.io/community/sig-network). Add the SIG label in a comment like so:
95
+
*Example:* if you are filing a CNI issue (that's [Container Networking Interface])
96
+
you'd choose the [Network SIG]. Add the SIG label in a new comment on GitHub
97
+
by typing the following:
75
98
```
76
99
/sig network
77
100
```
78
101
79
-
Follow the link in the SIG name column to reach each SIGs README.
80
-
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.
81
-
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/).
102
+
Follow the link in the SIG name column to reach each SIG'ss README.
103
+
104
+
Most SIGs will have a set of GitHub Teams with tags that can be mentioned in a
105
+
comment on issues and pull requests for higher visibility. If you are not sure
106
+
about the correct SIG for an issue, you can try [SIG-contributor-experience],
107
+
or [ask in Slack].
82
108
83
109
### SIG-specific contributing guidelines
84
-
Some SIGs have their own `CONTRIBUTING.md` files, which may contain extra information or guidelines in addition to these general ones.
85
-
These are located in the SIG-specific community directories:
110
+
111
+
Some SIGs have their own `CONTRIBUTING.md` files, which may contain extra information
112
+
or guidelines in addition to these general ones. These are located in the SIG-specific
0 commit comments