Issue Wranglers

Alongside the PR Wrangler, formal approvers, reviewers and members of SIG Docs take week-long shifts triaging and categorising issues for the repository.

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 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.

Requirements

  • Must be an active member of the Kubernetes organization.
  • A minimum of 15 non-trivial 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 for wranglers

Below are some commonly used commands for Issue Wranglers:

  1. # reopen an issue
  2. /reopen
  4. # transfer issues that don't fit in k/website to another repository
  5. /transfer[-issue]
  7. # change the state of rotten issues
  8. /remove-lifecycle rotten
  10. # change the state of stale issues
  11. /remove-lifecycle stale
  13. # assign sig to an issue
  14. /sig <sig_name>
  16. # add specific area
  17. /area <area_name>
  19. # for beginner friendly issues
  20. /good-first-issue
  22. # issues that needs help
  23. /help wanted
  25. # tagging issue as support specific
  26. /kind support
  28. # to accept triaging for an issue
  29. /triage accepted
  31. # closing an issue we won't be working on and haven't fixed yet
  32. /close not-planned

To find more Prow commands, refer to the Command Help documentation.

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.