kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Point contributors towards our new resources

This commit is contained in:
Jorge O. Castro 2018-01-19 10:15:49 -05:00
parent dd95c94d95
commit 53b83ab1e7
1 changed files with 7 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -2,31 +2,16 @@
Welcome to the Kubernetes Community contributing guide. We are excited about the prospect of you joining our [community](https://github.com/kubernetes/community)!
## Finding Something to Work On
## Getting Started
Before you begin, you can look at some places where you can help out:
We have full documentation on how to get started contributing here:
- [Existing open issues](https://github.com/kubernetes/community/issues)
- [Open Pull Requests](https://github.com/kubernetes/community/pulls) - Most of the pull requests in this repository are not code, but documentation and process. This is a great place to get started. Even if you do not have the rights to merge you can still help by doing a review.
- [Kubernetes Contributor Guide](http://git.k8s.io/community/contributors/guide) - Main contributor documentation
- [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet.md) - Common resources for existing developers
## Steps
## Mentorship
1. Make a [Pull Request](https://help.github.com/articles/using-pull-requests) (PR).
2. Upon successful review, someone will give the PR
a __LGTM__ (_looks good to me_) in the review thread.
3. 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.
### Trivial Edits
Each incoming Pull Request needs to be reviewed, checked, and then merged.
While automation helps with this, each contribution also has an engineering cost. Therefore it is appreciated if you do NOT make trivial edits and fixes, but instead focus on giving the entire file a review.
If you find one grammatical or spelling error, it is likely there are more in that file, you can really make your Pull Request count by checking formatting, checking for broken links, and fixing errors and then submitting all the fixes at once to that file.
Some questions to consider:
- Can the file be improved further?
- Does the trivial edit greatly improve the quality of the content?
- [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!
## Contributing to Individual SIGs
@ -37,3 +22,4 @@ by the respective SIG leads in the sub-directory's `CONTRIBUTING` file
(e.g. [sig-cli/CONTRIBUTING](sig-cli/CONTRIBUTING.md)).
Attending a [SIG meeting](/sig-list.md) or posting on their mailing list might be prudent if you want to make extensive contributions.