|
| 1 | +# Contributing to SIG Auth |
| 2 | + |
| 3 | +Welcome to contributing to SIG Auth. |
| 4 | + |
| 5 | +If you haven't seen them already, the Kubernetes project has: |
| 6 | + |
| 7 | +- A [Contributor Guide][contrib-guide] - some |
| 8 | + [kubernetes/kubernetes]-specific content, but lots of info for the |
| 9 | + entire project |
| 10 | +- A [Contributor Cheat Sheet][contrib-cheatsheet] - lots of resources |
| 11 | + and handy links |
| 12 | + |
| 13 | +SIG Auth has multiple areas you can contribute to. Those contributions |
| 14 | +can be in the form of code, documentation, support being involved in |
| 15 | +mailing list discussions, attending meetings, and more. This guide |
| 16 | +describes different major functional areas SIG Auth is involved in, |
| 17 | +provides an overview of the areas, and gives pointers on getting more |
| 18 | +involved in each area. Consider this a launching point or the start of |
| 19 | +a [choose your own |
| 20 | +adventure](https://en.wikipedia.org/wiki/Choose_Your_Own_Adventure) |
| 21 | +for SIG Auth. |
| 22 | + |
| 23 | +## Workflow |
| 24 | + |
| 25 | +Just like rest of the Kubernetes project, we also use the same PR and |
| 26 | +review based workflow. Which means [use of the CNCF CLA][cla], [code |
| 27 | +review by reviewers and approvers listed in OWNERS files][owners], and |
| 28 | +tests that automatically exercise code or enforce conventions. |
| 29 | + |
| 30 | +## Issue Triaging |
| 31 | + |
| 32 | +Issues are ideally labeled with: |
| 33 | + |
| 34 | +- milestone: during which release cycle do we plan on working on this issue |
| 35 | +- `sig/foo`: which SIG owns this work |
| 36 | +- `area/foo`: which subproject or code is this issue related to |
| 37 | +- `kind/foo`: which kind of work is this issue describing |
| 38 | +- `priority/foo`: how important is this issue |
| 39 | + |
| 40 | +For example, an issue related to cleaning up and consolidating |
| 41 | +(`kind/cleanup`) release-related (`sig/release`) jobs and dashboards |
| 42 | +(`area/config`) for the v1.16 cycle (`milestone: v1.16`) that may not |
| 43 | +get completed by the end of the cycle if more important or more urgent |
| 44 | +work arises (`priority/important-longterm`). |
| 45 | + |
| 46 | +We try to have a non-stale pool of issues that are available for new |
| 47 | +contributors who want to help out but aren't sure what to work on or where to |
| 48 | +get started: |
| 49 | + |
| 50 | +- [`label:"good first issue"`][good-first-issue] - triaged per |
| 51 | + [good-first-issue](https://github.com/issues?q=repo%3Akubernetes%2Fkubernetes+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A%22sig%2Fauth%22) |
| 52 | +- [good-first-issue-docs](https://git.k8s.io/community/contributors/guide/help-wanted.md#good-first-issue) |
| 53 | +- [`label:"help wanted"`][help-wanted] - triaged per |
| 54 | + [help-wanted](https://github.com/issues?q=repo%3Akubernetes%2Fkubernetes+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22++label%3A%22sig%2Fauth%22) |
| 55 | +- [help-wanted-docs](https://git.k8s.io/community/contributors/guide/help-wanted.md#help-wanted) |
| 56 | + |
| 57 | +## Guides |
| 58 | + |
| 59 | +If you're not sure where to contribute or what any of these mean, |
| 60 | +please see |
| 61 | +[README.md](https://github.com/kubernetes/community/blob/master/README.md) |
| 62 | +for a brief description of the various codebases in this repo. |
0 commit comments