First pass at revising the contributing guidelines #1240
Conversation
k8s-ci-robot
added
size/M
|
|
||
| Before you begin, you can look at some places where you can help out: | ||
|
|
||
| - [Existing open issues](https://github.com/kubernetes/community/issues) |
There was a problem hiding this comment.
Should we point to this repo only?
There was a problem hiding this comment.
Since this file is at the root of this repo I think this makes sense. We should probably revise k/k/contributing.md also.
There was a problem hiding this comment.
@castrojo is the goal of the document - documenting the contribution guidelines to kubernetes/community only, or to entire kubernetes codebase (everything under Kubernetes organization on GitHub)?
There was a problem hiding this comment.
@idvoretskyi This should be for k/community, however, k/k basically points to this repo and the developer guide. I think that step 2 should be revising k/k/contributing.md to point to the new developer guide (once complete).
CONTRIBUTING.md
Outdated
| 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. | ||
|
|
||
| ### Trivial Edits | ||
|
|
||
| Each incoming Pull Request needs to be reviewed, checked, have tests run, and then merged. |
There was a problem hiding this comment.
Actually, we don't have tests in this repo. We just have checks on CLA and lgtm.
CONTRIBUTING.md
Outdated
| A [SIG lead](sig-list.md) (or someone with approval powers | ||
| ## Steps | ||
|
|
||
| 1. Make a [pull request](https://help.github.com/articles/using-pull-requests) (PR). |
There was a problem hiding this comment.
s/pull request/Pull Request ?
Since we list its abbrev here, we can use PR instead of Pull Request in the below text, such as L24, L26
CONTRIBUTING.md
Outdated
|
|
||
| Make a [pull request](https://help.github.com/articles/using-pull-requests) (PR). | ||
| Welcome to the Kubernetes Community contributing guide. We are excited about the prospect of you joining our [community](https://github.com/kubernetes/community]! |
There was a problem hiding this comment.
[community](https://github.com/kubernetes/community]
The last "]" should be ")".
| 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. | ||
|
|
||
| ### Trivial Edits |
There was a problem hiding this comment.
I very much appreciate this being written down.. will help to link to this and ask that question when we get the spelling mistake PRs. Thank you! 👍
|
/test pull-community-verify |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cblecker The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these OWNERS Files:
You can indicate your approval by writing |
k8s-ci-robot
added
the
approved
|
/test all [submit-queue is verifying that this PR is safe to merge] |
|
Automatic merge from submit-queue. |
Note: There is a larger effort to write a full contributor guide, so this is mostly a revision. Biggest change is an addition of a section for how we should deal with trivial edits, which mostly is a crib from StackOverflow's policies on dealing with trivial edits.
Fixes #1226