Skip to content

Commit eb85dc5

Browse files
authored
Merge pull request #5848 from pravarag/add-contributing-for-sig-auth
Add CONTRIBUTING.md under SIG Auth
2 parents 552d6fd + 47a20fd commit eb85dc5

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

sig-auth/CONTRIBUTING.md

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

0 commit comments

Comments
 (0)