Merge pull request #440 from monopole/contributorFixes
Fix links, tighten text, rename file to standard naming.
This commit is contained in:
Brian Grant
GitHub
commit
85057eacad
|
|
@ -1,30 +1,17 @@
|
|||
# Contributing to the community repo
|
||||
|
||||
|
||||
Contributions to this community repository follow a
|
||||
[pull request](https://help.github.com/articles/using-pull-requests/) (PR)
|
||||
model:
|
||||
|
||||
#### 1. Submit a PR with your change
|
||||
|
||||
#### 2. Get an LGTM.
|
||||
Make a [pull request](https://help.github.com/articles/using-pull-requests) (PR).
|
||||
|
||||
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.
|
||||
A [SIG lead](sig-list.md) (or someone with approval powers
|
||||
as specified in an OWNERS file) may merge the PR immediately
|
||||
with or without an LGTM from someone else.
|
||||
Or they may wait a business day to get further feedback from other reviewers.
|
||||
|
||||
Edits in SIG sub-directories should follow any additional guidelines described
|
||||
by the respective SIG leads in the sub-directory's `CONTRIBUTING` file
|
||||
(e.g. [sig-cli/CONTRIBUTING](sig-cli/CONTRIBUTING.md)).
|
||||
|
||||
|
||||
25
README.md
25
README.md
|
|
@ -3,10 +3,11 @@
|
|||
Welcome to the Kubernetes community!
|
||||
|
||||
This is the starting point for becoming a contributor - improving docs, improving code, giving talks etc.
|
||||
|
||||
## Communicating
|
||||
|
||||
General communication channels - e.g. filing issues, chat, mailing lists and
|
||||
conferences are listed on the [communication](communication.md) page.
|
||||
The [communication](communication.md) page lists communication channels like chat,
|
||||
issues, mailing lists, conferences, etc.
|
||||
|
||||
For more specific topics, try a SIG.
|
||||
|
||||
|
|
@ -18,10 +19,10 @@ A first step to contributing is to pick from the [list of kubernetes SIGs](sig-l
|
|||
|
||||
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)),
|
||||
folder in this repo (e.g. [sig-cli/CONTRIBUTING](sig-cli/CONTRIBUTING.md)),
|
||||
and its own mailing list, slack channel, etc.
|
||||
|
||||
## How Can I help?
|
||||
## How Can I Help?
|
||||
|
||||
Documentation (like the text you are reading now) can
|
||||
always use improvement!
|
||||
|
|
@ -31,7 +32,7 @@ that should not need deep knowledge of the system.
|
|||
|
||||
To dig deeper, read a design doc, e.g. [architecture].
|
||||
|
||||
[Pick a SIG](sig-list.md), peruse its associated [cmd] directory,
|
||||
[Pick a SIG](sig-list), 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
|
||||
|
|
@ -48,14 +49,14 @@ lead to many relevant topics, including
|
|||
* [expectations] - what the community expects
|
||||
* [pull request] policy - how to prepare a pull request
|
||||
|
||||
## Making a Pull Request
|
||||
## Your First Contribution
|
||||
|
||||
We recommend that you work on existing issues before attempting
|
||||
We recommend that you work on existing [issues] before attempting
|
||||
to [develop a new feature].
|
||||
|
||||
Find an existing issue (e.g. one marked [help-wanted], or simply
|
||||
ask a SIG lead for suggestions), and respond on the issue thread
|
||||
expressing interest in working on it.
|
||||
ask a [SIG lead](sig-list) for suggestions), and respond on the
|
||||
issue thread expressing interest in working on it.
|
||||
|
||||
This helps other people know that the issue is active, and
|
||||
hopefully prevents duplicated efforts.
|
||||
|
|
@ -72,15 +73,17 @@ If you want to work on a new idea of relatively small scope:
|
|||
1. Submit a [pull request] containing a tested change.
|
||||
|
||||
|
||||
[architecture]: https://github.com/kubernetes/kubernetes/blob/master/docs/design/architecture.md
|
||||
[architecture]: https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture.md
|
||||
[cmd]: https://github.com/kubernetes/kubernetes/tree/master/cmd
|
||||
[CLA]: cla.md
|
||||
[CLA]: CLA.md
|
||||
[Collaboration Guide]: contributors/devel/development.md
|
||||
[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%3Ahelp-wanted
|
||||
[issues]: https://github.com/kubernetes/kubernetes/issues
|
||||
[pull request]: contributors/devel/pull-requests.md
|
||||
[sig-list]: sig-list.md
|
||||
|
||||
[]()
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue