Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: windsonsea <[email protected]>
  • Loading branch information
windsonsea committed Apr 23, 2023
1 parent aced6ae commit 9560b7f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Community Code of Conduct
# Community Code of Conduct

Clusterpedia follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
10 changes: 5 additions & 5 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This doc outlines the various responsibilities of contributor roles in Clutserpe
|Reviewer|Review contributions from other members|[OWNERS](#submodel-and-owners-files) file reviewer entry|
|Approver|Contributions acceptance approval|[OWNERS](#submodel-and-owners-files) file approver entry|

## Member
## Members
Members are continuously active contributors in the community. They can have issues and PRs assigned to them.
Members are expected to remain active contributors to the community.

Expand All @@ -28,9 +28,9 @@ Members are expected to remain active contributors to the community.
* Members can do `/lgtm` on open PRs.
* They can be assigned to issues and PRs, and people can ask members for reviews with a `/cc @username.`

**Note**: members who frequently contribute code are expected to proactively perform code reviews and work towards becoming a primary reviewer for the [submodel](#submodel-and-owners-files) that they are active in.
**Note**: Members who frequently contribute code are expected to proactively perform code reviews and work towards becoming a primary reviewer for the [submodel](#submodel-and-owners-files) that they are active in.

## Reviewer
## Reviewers
Reviewers are able to review code for quality and correctness on the [submodel](#submodel-and-owners-files).
They are knowledgeable about both the codebase and software engineering principles.

Expand All @@ -40,7 +40,7 @@ Reviewer status is scoped to a part of the codebase.

### Requirements
The following apply to the part of codebase for which one would be a reviewer in an [OWNERS](#submodel-and-owners-files) file (for repos using the bot).
* **member for at least 1 months**
* **member for at least 1 month**
* **Primary reviewer for at least 3 PRs to the codebase**
* **Reviewed or merged at least 10 substantial PRs to the codebase**
* Knowledgeable about the codebase
Expand All @@ -60,7 +60,7 @@ The following apply to the part of codebase for which one would be a reviewer in
* Assigned PRs to review related to [submodel](#submodel-and-owners-files) of expertise
* Assigned test bugs related to [submodel](#submodel-and-owners-files) of expertise

## Approver
## Approvers
Code approvers are able to both review and approve code contributions. While code review is focused on code quality and correctness, approval is focused on holistic acceptance of a contribution including: backwards / forwards compatibility, adhering to API and flag conventions, subtle performance and correctness issues, interactions with other parts of the system, etc.

**Defined by**: approvers entry in an [OWNERS](#submodel-and-owners-files) file
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Clusterpedia also provides a `Default Storage Layer` that can connect with **MyS
---

## Search Label and URL Query
|Role| search label key|url query|
|Role| Search label key|URL query|
| -- | --------------- | ------- |
|Filter cluster names|`search.clusterpedia.io/clusters`|`clusters`|
|Filter namespaces|`search.clusterpedia.io/namespaces`|`namespaces`|
Expand Down Expand Up @@ -351,6 +351,6 @@ If you have any question, feel free to reach out to us in the following ways:
Made with [contrib.rocks](https://contrib.rocks).

## License
Copyright 2022 the Clusterpedia Authors. All rights reserved.
Copyright 2023 the Clusterpedia Authors. All rights reserved.

Licensed under the Apache License, Version 2.0.

0 comments on commit 9560b7f

Please sign in to comment.