docs/contributing

Important. Before proceeding, please review the Knative community Code of Conduct.

If you any have questions or concerns, please contact the authors at knative-code-of-conduct@googlegroups.com.

Welcome!

Welcome to the Knative community!

This is the starting point for becoming a contributor - improving code, improving docs, giving talks, etc.

• Introduction
• Knative authors
  • Authoring samples
• Meetings and work groups
• How can I help?
• Questions and issues

Other Documents

• Code of Conduct - all contributors must abide by the code of conduct
• Contributing to Knative - guidelines and advice on becoming a contributor
• Working Groups - describes our various working groups
• Working Group Processes - describes how working groups operate
• Technical Oversight Committee - describes our technical oversight committee
• Steering Committee - describes our steering committee
• Community Roles - describes the roles individuals can assume within the Knative community
• Reviewing and Merging Pull Requests - how we manage pull requests

Introduction

Knative is a Kubernetes-based platform to build, deploy, and manage modern serverless workloads. See Knative docs for in-depth information about using Knative.

Knative authors

Knative is an open source project with an active development community. The project was started by Google but has contributions from a growing number of industry-leading companies. For a current list of the authors, see Authors.

Authoring samples

Beyond the official documentation there are endless possibilities for combining tools, platforms, languages, and products. By submitting a tutorial you can share your experience and help others who are solving similar problems.

Community tutorials are stored in Markdown files under the community folder Community Samples. These documents are contributed, reviewed, and maintained by the community.

Submit a Pull Request to the community sample directory under the Knative component folder that aligns with your document. For example, Knative Serving samples are under the serving folder. A reviewer will be assigned to review your submission. They'll work with you to ensure that your submission is clear, correct, and meets the style guide, but it helps if you follow it as you write your tutorial.

Meetings and work groups

Knative has public and recorded bi-weekly community meetings.

Each project has one or more working groups driving the project, and Knative as a single technical oversight community monitoring the overall project.

How can I help

If you're looking for something to do to get your feet wet working on Knative, look for GitHub issues marked with the Help Wanted label:

• Build issues
• Eventing issues
• Serving issues
• Documentation repo

Even if there's not an issue opened for it, we can always use more testing throughout the platform. Similarly, we can always use more docs, richer docs, insightful docs. Or maybe a cool blog post? And if you're a web developer, we could use your help in spiffing up our public-facing web site.

Questions and issues

If you're a developer, operator, or contributor trying to use Knative, the following resources are available for you:

• Knative Users
• Knative Developers

For contributors to Knative, we also have Knative Slack.

---

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.