...

Text file src/sigs.k8s.io/json/CONTRIBUTING.md

Documentation: sigs.k8s.io/json

     1# Contributing Guidelines
     2
     3Welcome to Kubernetes. We are excited about the prospect of you joining our [community](https://git.k8s.io/community)! The Kubernetes community abides by the CNCF [code of conduct](code-of-conduct.md). Here is an excerpt:
     4
     5_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._
     6
     7## Criteria for adding code here
     8
     9This library adapts the stdlib `encoding/json` decoder to be compatible with 
    10Kubernetes JSON decoding, and is not expected to actively add new features.
    11
    12It may be updated with changes from the stdlib `encoding/json` decoder.
    13
    14Any code that is added must:
    15* Have full unit test and benchmark coverage
    16* Be backward compatible with the existing exposed go API
    17* Have zero external dependencies
    18* Preserve existing benchmark performance
    19* Preserve compatibility with existing decoding behavior of `UnmarshalCaseSensitivePreserveInts()` or `UnmarshalStrict()`
    20* Avoid use of `unsafe`
    21
    22## Getting Started
    23
    24We have full documentation on how to get started contributing here:
    25
    26<!---
    27If your repo has certain guidelines for contribution, put them here ahead of the general k8s resources
    28-->
    29
    30- [Contributor License Agreement](https://git.k8s.io/community/CLA.md) Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests
    31- [Kubernetes Contributor Guide](https://git.k8s.io/community/contributors/guide) - Main contributor documentation, or you can just jump directly to the [contributing section](https://git.k8s.io/community/contributors/guide#contributing)
    32- [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet) - Common resources for existing developers
    33
    34## Community, discussion, contribution, and support
    35
    36You can reach the maintainers of this project via the 
    37[sig-api-machinery mailing list / channels](https://github.com/kubernetes/community/tree/master/sig-api-machinery#contact).
    38
    39## Mentorship
    40
    41- [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!
    42

View as plain text