Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

65 lines (51 loc) · 3 KB
Raw

Contributing to SIG Auth

Welcome to contributing to SIG Auth.

If you haven't seen them already, the Kubernetes project has:

SIG Auth has multiple areas you can contribute to. Those contributions can be in the form of code, documentation, support being involved in mailing list discussions, attending meetings, and more. This guide describes different major functional areas SIG Auth is involved in, provides an overview of the areas, and gives pointers on getting more involved in each area. Consider this a launching point or the start of a choose your own adventure for SIG Auth.

Workflow

Just like rest of the Kubernetes project, we also use the same PR and review based workflow. Which means use of the CNCF CLA, code review by reviewers and approvers listed in OWNERS files, and tests that automatically exercise code or enforce conventions.

Issue Triaging

Issues are ideally labeled with:

  • milestone: during which release cycle do we plan on working on this issue
  • sig/foo: which SIG owns this work
  • area/foo: which subproject or code is this issue related to
  • kind/foo: which kind of work is this issue describing
  • priority/foo: how important is this issue

For example, an issue related to cleaning up and consolidating (kind/cleanup) release-related (sig/release) jobs and dashboards (area/config) for the v1.16 cycle (milestone: v1.16) that may not get completed by the end of the cycle if more important or more urgent work arises (priority/important-longterm).

We try to have a non-stale pool of issues that are available for new contributors who want to help out but aren't sure what to work on or where to get started:

Guides

If you're not sure where to contribute or what any of these mean, please see README.md for a brief description of the various codebases in this repo.