-
Notifications
You must be signed in to change notification settings - Fork 14.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42273 from haripriya9647/pr
created issue-wrangler.md
- Loading branch information
Showing
1 changed file
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
title: Issue Wranglers | ||
content_type: concept | ||
weight: 20 | ||
--- | ||
|
||
<!-- overview --> | ||
|
||
Alongside the [PR Wrangler](/docs/contribute/participate/pr-wranglers),formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. | ||
|
||
<!-- body --> | ||
|
||
## Duties | ||
|
||
Each day in a week-long shift the Issue Wrangler will be responsible for: | ||
|
||
- Triaging and tagging incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. | ||
- Keeping an eye on stale & rotten issues within the kubernetes/website repository. | ||
- Maintenance of the [Issues board](https://github.com/orgs/kubernetes/projects/72/views/1). | ||
|
||
### Requirements | ||
|
||
- Must be an active member of the Kubernetes organization. | ||
- A minimum of 15 [non-trivial](https://www.kubernetes.dev/docs/guide/pull-requests/#trivial-edits) contributions to Kubernetes (of which a certain amount should be directed towards kubernetes/website). | ||
- Performing the role in an informal capacity already | ||
|
||
### Helpful [Prow commands](https://prow.k8s.io/command-help) for wranglers | ||
|
||
``` | ||
# reopen an issue | ||
/reopen | ||
# transfer issues that don't fit in k/website to another repository | ||
/transfer[-issue] | ||
# change the state of rotten issues | ||
/remove-lifecycle rotten | ||
# change the state of stale issues | ||
/remove-lifecycle stale | ||
# assign sig to an issue | ||
/sig <sig_name> | ||
# add specific area | ||
/area <area_name> | ||
# for beginner friendly issues | ||
/good-first-issue | ||
# issues that needs help | ||
/help wanted | ||
# tagging issue as support specific | ||
/kind support | ||
# to accept triaging for an issue | ||
/triage accepted | ||
# closing an issue we won't be working on and haven't fixed yet | ||
/close not-planned | ||
``` | ||
|
||
### When to close Issues | ||
|
||
For an open source project to succeed, good issue management is crucial. But it is also critical to resolve issues in order to maintain the repository and communicate clearly with contributors and users. | ||
|
||
Close issues when: | ||
|
||
- A similar issue is reported more than once.You will first need to tag it as /triage duplicate; link it to the main issue & then close it. It is also advisable to direct the users to the original issue. | ||
- It is very difficult to understand and address the issue presented by the author with the information provided. | ||
However, encourage the user to provide more details or reopen the issue if they can reproduce it later. | ||
- The same functionality is implemented elsewhere. One can close this issue and direct user to the appropriate place. | ||
- The reported issue is not currently planned or aligned with the project's goals. | ||
- If the issue appears to be spam and is clearly unrelated. | ||
- If the issue is related to an external limitation or dependency and is beyond the control of the project. | ||
|
||
To close an issue, leave a `/close` comment on the issue. |