ceph-csi/api/vendor/sigs.k8s.io/json/CONTRIBUTING.md
Niels de Vos ce603fb47e rebase: update to latest github.com/openshift/api version
Also vendor all dependencies.

Signed-off-by: Niels de Vos <ndevos@ibm.com>
2024-01-22 07:16:53 +00:00

2.3 KiB

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.

Criteria for adding code here

This library adapts the stdlib encoding/json decoder to be compatible with Kubernetes JSON decoding, and is not expected to actively add new features.

It may be updated with changes from the stdlib encoding/json decoder.

Any code that is added must:

  • Have full unit test and benchmark coverage
  • Be backward compatible with the existing exposed go API
  • Have zero external dependencies
  • Preserve existing benchmark performance
  • Preserve compatibility with existing decoding behavior of UnmarshalCaseSensitivePreserveInts() or UnmarshalStrict()
  • Avoid use of unsafe

Getting Started

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

Community, discussion, contribution, and support

You can reach the maintainers of this project via the sig-api-machinery mailing list / channels.

Mentorship

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