Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (21 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

25 lines (21 loc) · 1.79 KB
Raw

Contributing guidelines

Prerequisites

How to run unit tests locally

  1. Make sure kubebuilder is installed.
  2. Run make test in the project root directory.

Developing guidelines

  • Be sure to run make update or make test before you finish a commit.
  • If CRDs in deploy/crds are updated, the same file names located in deploy/olm-catalog/ibm-block-csi-operator must be updated accordingly.
  • If role.yaml, role_binding.yaml, or operator.yaml in deploy are updated, the ClusterServiceVersion(CSV) file in deploy/olm-catalog/ibm-block-csi-operator must be updated accordingly.
  • If README.md is updated, ClusterServiceVersion(CSV) file in deploy/olm-catalog/ibm-block-csi-operator must be updated accordingly.
  • Run operator-sdk add to add a new API or controller, for more details, please refer to https://github.com/operator-framework/operator-sdk.
  • Run operator-sdk generate k8s and operator-sdk generate crds after you change something in pkg/apis.

Package the Operator

This repository makes use of the Operator Framework and its packaging concept for Operators. Make sure you read the following guides before packaging the operator and uploading to OperatorHub.