mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-17 18:25:26 +00:00
72 lines
4.7 KiB
Markdown
72 lines
4.7 KiB
Markdown
[SIG-CLI]: https://github.com/kubernetes/community/tree/master/sig-cli
|
|
[Slack channel]: https://kubernetes.slack.com/messages/kustomize
|
|
[Mailing list]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli
|
|
|
|
[OWNERS file spec]: https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md
|
|
[Kustomize OWNERS_ALIASES]: https://github.com/kubernetes-sigs/kustomize/blob/8049f7b1af52e8a7ec26faf6cf714f560d0043c5/OWNERS_ALIASES
|
|
[SIG-CLI Teams]: https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cli/teams.yaml
|
|
[Github permissions]: https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#repository-access-for-each-permission-level
|
|
|
|
[Contributor License Agreement]: https://git.k8s.io/community/CLA.md
|
|
[Kubernetes Contributor Guide]: http://git.k8s.io/community/contributors/guide
|
|
[Contributor Cheat Sheet]: https://git.k8s.io/community/contributors/guide/contributor-cheatsheet/README.md
|
|
[CNCF Code of Conduct]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
|
|
[Kubernetes Community Membership]: https://github.com/kubernetes/community/blob/master/community-membership.md
|
|
|
|
[Contribution Guide]: https://kubectl.docs.kubernetes.io/contributing/kustomize/
|
|
[MacOS Dev Guide]: https://kubectl.docs.kubernetes.io/contributing/kustomize/mac/
|
|
[Windows Dev Guide]: https://kubectl.docs.kubernetes.io/contributing/kustomize/windows/
|
|
|
|
# Contributing Guidelines
|
|
|
|
Welcome to Kubernetes. We are excited about the prospect of you joining our [community](https://github.com/kubernetes/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
|
|
|
|
Dev guides:
|
|
|
|
- [Contribution Guide]
|
|
- [MacOS Dev Guide]
|
|
- [Windows Dev Guide]
|
|
|
|
General resources for contributors:
|
|
|
|
- [Contributor License Agreement] - Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests.
|
|
- [Kubernetes Contributor Guide] - Main contributor documentation.
|
|
- [Contributor Cheat Sheet] - Common resources for existing developers.
|
|
|
|
Here are some additional ideas to help you get started with Kustomize:
|
|
- Attend a Kustomize Bug Scrub. Check the [SIG-CLI] meetings list to find the next one.
|
|
- Help triage issues by confirming validity and applying the appropriate `kind` label (e.g. comment `/kind bug`).
|
|
- Pick up an issue to fix. Issues with the `help-wanted` label are a good place to start, but you can also look for any issue with the `triage/accepted` label and no assignee. Remember to `/assign` yourself to let others know you're working on it.
|
|
- Help confirm new issues labelled `kind/bug` by reproducing them with the latest release.
|
|
- Support Kustomize users by responding to questions on issues labelled `kind/support` or in the [Slack channel].
|
|
|
|
## Mentorship
|
|
|
|
- [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!
|
|
|
|
## Contributor Ladder
|
|
|
|
Kustomize follows the [Kubernetes Community Membership] contributor ladder. Roles are as follows:
|
|
|
|
1. Contributor: Anyone who actively contributes code, issues or reviews to the project. All contributors must sign the [Contributor License Agreement].
|
|
1. Reviewer: Contributors with a history of review and authorship on Kustomize. Has LGTM rights on the Kustomize repo (as do all kubernetes-sigs org members). Active contributors are encouraged to join the reviewers list to be automatically pinged on PRs.
|
|
1. Approver: Highly experienced active reviewer and contributor to Kustomize. Has both LTGM and approval rights on the Kustomize repo, as well as "maintain" [Github permissions].
|
|
1. Owner: Approver who sets technical direction and makes or approves design decisions for the project. Has LGTM and approval rights on the Kustomize repo as well as "admin" [Github permissions].
|
|
|
|
The kyaml module within the Kustomize repo has additional owners following the same ladder.
|
|
|
|
Administrative notes:
|
|
|
|
- The [OWNERS file spec] is a useful resources in making changes.
|
|
- Maintainers and admins must be added to the appropriate lists in both [Kustomize OWNERS_ALIASES] and [SIG-CLI Teams]. If this isn't done, the individual in question will lack either PR approval rights (Kustomize list) or the appropriate Github repository permissions (community list).
|
|
|
|
|
|
## Contact Information
|
|
|
|
- [Slack channel]
|
|
- [Mailing list]
|