Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

76 lines (56 loc) · 3.37 KB

Contributing Guidelines

Welcome to Kubernetes. We are excited about the prospect of you joining our community! The Kubernetes community abides by the CNCF code of conduct. Here is an excerpt:

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

Getting Started

We have full documentation on how to get started contributing here:

Prerequisites

  • go version v1.15+.
  • docker version 17.03+.
  • kubectl version v1.19+.
  • Access to a Kubernetes v1.19+ cluster.

Contributing steps

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

What to do before submitting a pull request

Following the targets that can be used to test your changes locally.

Command Description Is called in the CI?
make test-unit Runs go tests yes
make test-e2e Runs the CI e2e tests locally yes
make verify-go-lint Run [golangci][golangci] lint checks yes
make verify Run all verification checks yes

Where the CI Tests are configured

  1. See the action files to check its tests, and the scripts used on it.
  2. Note that the prow tests used in the CI are configured in kubernetes-sigs/security-profiles-operator/security-profiles-operator-presubmits.yaml.

Mentorship

  • Mentoring Initiatives - We have a diverse set of mentorship programs available that are always looking for volunteers!

Contact Information