-
Notifications
You must be signed in to change notification settings - Fork 14.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
created issue-wrangler.md #42273
created issue-wrangler.md #42273
Changes from 4 commits
67b931e
5cc83a8
dcee41b
68de69d
1cf3b64
bc77cff
b3ee866
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,77 @@ | ||||||
--- | ||||||
title: Issue Wranglers | ||||||
content_type: concept | ||||||
weight: 20 | ||||||
--- | ||||||
|
||||||
<!-- overview --> | ||||||
|
||||||
In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wranglers),and 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 as Issue Wrangler: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit
Suggested change
|
||||||
|
||||||
- Triage and tag 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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- Identifying whether the issue falls under the support category and assigning a "triage/accepted" status. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- Ensuring the issue is tagged with the appropriate sig/area/kind labels. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- Keeping an eye on stale & rotten issues within the kubernetes/website repository. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- Maintenance of [Issues board](https://github.com/orgs/kubernetes/projects/72/views/1) would be nice | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
### 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 | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Extra: mention |
||||||
|
||||||
``` | ||||||
# 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 | ||||||
``` | ||||||
|
||||||
haripriya9647 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
### 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: | ||||||
|
||||||
- When a similar issue is reported more than once, you'll first 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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- 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. | ||||||
- Having implemented the same functionality elsewhere. One can close this issue and direct user to the appropriate place. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- Feature requests that are not currently planned or aligned with the project's goals. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- In cases where an issue appears to be spam and is clearly unrelated. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.