Contribute to the project

There are many ways to contribute to OpenFaaS and a wide variety of activities that help both the project and the community.

Before raising a PR or an Issue, it is requested that you read the project’s Contributing guide. This guide applies to every OpenFaaS GitHub repository. We have a wide range of suggestions for contributing to the project and community and only some of those involve writing code.

Examples may be: writing some Go code, reviewing a PR, helping with the website or UI, volunteering to write documentation for a new feature, creating code examples, or something else completely.

Five practical ideas to get started

• Try the workshop

• Read the architecture diagrams

• Submit a function to the Function Store

• Write a blog post and add it to the community file

• Improve the OpenFaaS CLI tooling with a PR or documentation

Get up to speed

If you are new with Docker, Kubernetes, or Go and would like to learn or just improve your skills, you may find the following links useful.

Check out Alex’s eBook on Everyday Go - with examples, recipes and techniques used on the OpenFaaS project in production: Everyday Go

• Golang
  • Go Official Website
  • Go Official Documentation
  • Alex Ellis’ golang basics tutorial series
  • The Case For Go - a list of sources collected by Erik Unger
  • Another interesting blog post - Why should you learn Go? by Keval Patel
  • Official Golang GitHub account
• Books useful for learning Golang
  • The Go Programming Language (Addison-Wesley Professional Computing)
  • The Clean Coder: A Code of Conduct for Professional Programmers (Robert C. Martin)
• Kubernetes
  • Kubernetes Documentation
  • Tutorials from Alex Ellis
• Docker
  • Docker Documentation
• Travis CI User Documentation

Communicate with the community

Let the project team know in the #contributors channel on Slack.

• Decide how many hours you think you may be able to contribute
• Think about where you are most comfortable starting out and what you would like to work on
• Ask for help if you don’t know where to begin

Code repositories

All project source-code is organised under two repositories on GitHub:

• openfaas - main set of projects
• openfaas-incubator - ecosystem, extensions, and prototyping

See a detailed list of Code Repositories.