Skip to content

Commit e9e04cf

Browse files
authored
Enhance README with contributing guide and goals
Added purpose and structure to the README for contributors. Signed-off-by: Jorge O. Castro <[email protected]>
1 parent 467a66e commit e9e04cf

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
WIP site for contribute.cncf.io
1+
## This will eventually be the contributing guide, for now we want it up front
2+
3+
## Purpose
4+
5+
One source of truth for all of the information that a CNCF Contributor would find useful. Additionally it will act as a reference point to other open source communities - we want to represent our "style" of open source, in a way that is consumable by others.
6+
7+
We hope that you visit this site often.
8+
9+
## The Golden Path
10+
11+
We want to focus on the golden path first:
12+
13+
- The individual - skills you need to be an effective contributor
14+
- The project - skills needed to manage projects, a different skillset
15+
- The community - the group of groups, the larger governance structures like the TOC and TABs
16+
17+
_A healthy ecosystem will encourage the development of all three of these skills_.
18+
19+
The site is intended to be read in this order by a new contributor. It is also intended to support you through your entire cloud native journey, we expect mentors and experienced individuals to also share advanced things.
20+
21+
## ChillOps
22+
23+
Feel free to start diving in with PRs, we want to remain opinionated on this golden path for now, and then add branches and side quests after we've shipped more meat. We want people to feel good when they read this site because they found something useful, so feel free to file issues with your ideas!

0 commit comments

Comments
 (0)