Skip to content

Latest commit

 

History

History
122 lines (91 loc) · 5.45 KB

CONTRIBUTING.md

File metadata and controls

122 lines (91 loc) · 5.45 KB
Raw

Introduction

Let's start with the relationship between several related projects:

  • Kubernetes is a container orchestration system, and is used to run containers on a cluster
  • containerized-data-importer (CDI) is an add-on which solves the problem of populating Kubernetes Persistent Volumes with data. It was written to be general purpose but with the virtualization use case in mind. Therefore, it has a close relationship and special integration with KubeVirt.
  • KubeVirt is an add-on which is installed on-top of Kubernetes, to be able to add basic virtualization functionality to Kubernetes.

As an add-on to Kubernetes, CDI shares some philosophy and design choices:

  • Mostly written in golang
  • Often related to distributed microservice architectures
  • Declarative and Reactive (Operator pattern) approach

This short page shall help to get started with the projects and topics surrounding them. If you notice a strong similarity with the KubeVirt contribution guidelines it's because we have taken inspiration from their success.

Contributing to CDI

Our workflow

Contributing to CDI should be as simple as possible. Have a question? Want to discuss something? Want to contribute something? Just open an Issue or a Pull Request. For discussion, we use the KubeVirt Google Group.

If you spot a bug or want to change something pretty simple, just go ahead and open an Issue and/or a Pull Request, including your changes at kubevirt/containerized-data-importer.

For bigger changes, please create a tracker Issue, describing what you want to do. Then either as the first commit in a Pull Request, or as an independent Pull Request, provide an informal design proposal of your intended changes. The location for such propoals is /docs in the CDI repository. Make sure that all your Pull Requests link back to the relevant Issues.

Getting started

To make yourself comfortable with the code, you might want to work on some Issues marked with one or more of the following labels help wanted, good first issue, or bug. Any help is greatly appreciated.

Testing

Untested features do not exist. To ensure that what we code really works, relevant flows should be covered via unit tests and functional tests. So when thinking about a contribution, also think about testability. All tests can be run local without the need of CI. Have a look at the Developer Guide.

Getting your code reviewed/merged

Maintainers are here to help you enabling your use-case in a reasonable amount of time. The maintainers will try to review your code and give you productive feedback in a reasonable amount of time. However, if you are blocked on a review, or your Pull Request does not get the attention you think it deserves, reach out for us via Comments in your Issues, or ping us on IRC #kubevirt @irc.freenode.net.

Maintainers are:

  • @awels
  • @j-griffith
  • @aglitke

PR Checklist

Before your PR can be merged it must meet the following criteria:

  • README.md has been updated if core functionality is affected.
  • Complex features need standalone documentation in doc/.
  • Functionality must be fully tested. Unit test code coverage as reported by Goveralls must not decrease unless justification is given (ie. you're adding generated code).

Projects & Communities

CDI

KubeVirt

Kubernetes

Additional Topics