Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.99 KB
Raw

Contributing Guidelines

The KUDO Operators project accepts contributions via GitHub pull requests. This document outlines the process to help get your contribution accepted.

Developer Certificate Of Origin

KUDO Operators requires that contributors sign off on changes submitted to kudobuilder repositories. The Developer Certificate of Origin (DCO) is a simple way to certify that you wrote or have the right to submit the code you are contributing to the project.

You sign-off by adding the following to your commit messages:

This is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

Git has a -s command line option to do this automatically.

git commit -s -m 'This is my commit message'

You can find the full text of the DCO here: https://developercertificate.org/

How to Contribute to an Existing Operator

  1. Submit an issue describing your proposed change to the operator in question.
  2. The operator maintainer or repository owners will respond to your issue promptly
  3. If your proposed change is accepted and you haven't already done so, sign the Contributor License Agreement (see details above).
  4. Fork the KUDO Operators repository, develop and test your code changes in the relevant Operator directory.
  5. Submit a pull request.

Requirements for new Operators

  • Must include a README.md
  • Must include source GitHub repositories and/or Dockerfiles for Docker images used in the Operator
  • Must pass kubectl kudo package verify
  • Must specify the minimum KUDO version and Kubernetes version in operator.yaml
  • Must provide at least one passing deploy plan test for the Operator
  • Must follow the structure described in getting started guide
  • Each file in templates directory must be of one Kubernetes object type
  • Should support Operator upgrades
  • Should provide a sane default configuration

Release Process

The release process will be automated in upcoming iterations. Right now there are two ways to manually trigger the release process:

  • Submit an issue describing which operator has to be released
  • Use the KUDO Slack channel to ask the owners of the repository to release the operator

Reporting an issue in KUDO

This repository is used by KUDO Operator developers. If your issue is in the KUDO itself, please use the issue tracker in the kudobuilder/kudo repository.

Community, Discussion, and Support

Learn how to engage with the KUDO community on the community page.

You can reach the maintainers of this project at:

Code of Conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.