kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update issue-triage.md 

Very small grammar corrections.
This commit is contained in:
Kiran 2019-06-05 12:47:49 +12:00 committed by GitHub
parent 696e6a2c37
commit 71c5d0fe27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
contributors/guide/issue-triage.md
View File

@ -5,11 +5,11 @@
Speed up issue management. Speed up issue management.
The Kubernetes issues are listed at https://github.com/kubernetes/kubernetes/issues The Kubernetes issues are listed at https://github.com/kubernetes/kubernetes/issues
and are identified with labels. For example, an issue that belongs to SIG and are identified with labels. For example, an issue that belongs to the SIG
Network group will eventually be set to label `sig/network`. New issues will Network group will eventually be set to label `sig/network`. New issues will
start out without any labels. The detailed list of labels can be found at start out without any labels. The detailed list of labels can be found at
https://github.com/kubernetes/kubernetes/labels. While working on triaging https://github.com/kubernetes/kubernetes/labels. While working on triaging
issues you may not have privilege to assign specific label (e.g. `triaged`) issues you may not have privilege to assign a specific label (e.g. `triaged`)
and in that case simply add a comment in the issue with your findings. and in that case simply add a comment in the issue with your findings.
Following are few predetermined searches on issues for convenience: Following are few predetermined searches on issues for convenience:
@ -23,15 +23,15 @@ Following are few predetermined searches on issues for convenience:
These guidelines serves as a primary document for triaging incoming issues to These guidelines serves as a primary document for triaging incoming issues to
Kubernetes. SIGs and projects are encouraged to either use these guidelines, or Kubernetes. SIGs and projects are encouraged to either use these guidelines, or
use this as a starting point if necessary. For example if your SIG has specific use this as a starting point if necessary. For example, if your SIG has specific
triaging needs, extend these guidelines. triaging needs, extend these guidelines.
**Note:** These guidelines only applies to the kubernetes repository. Its usage **Note:** These guidelines only applies to the Kubernetes repository. Its usage
for other github repositories related to Kubernetes is TBD. for other GitHub repositories related to Kubernetes is TBD.
## Using the bot ## Using the bot
Most people can leave comments and open issues. They don't have the ability to Most people can leave comments and open issues. They don't have the ability to
set labels, change milestones and close other peoples issues. For that we use set labels, change milestones and close other people's issues. For that we use
a bot to manage labelling and triaging. The bot has a set of a bot to manage labelling and triaging. The bot has a set of
[commands and permissions](https://go.k8s.io/bot-commands) [commands and permissions](https://go.k8s.io/bot-commands)
and this document will cover the basic ones. and this document will cover the basic ones.
@ -42,8 +42,8 @@ Sometimes users ask for support requests in issues; these are usually requests
from people who need help configuring some aspect of Kubernetes. These issues from people who need help configuring some aspect of Kubernetes. These issues
should be labeled with `triage/support`, directed to our support structures should be labeled with `triage/support`, directed to our support structures
(see below) and then closed. Also, if the issue is clearly abandoned or in the (see below) and then closed. Also, if the issue is clearly abandoned or in the
wrong place, it should be closed. Keep in mind that only issue reporter, wrong place, it should be closed. Keep in mind that only issue reporters,
assignees and component organization members can close issue. If you do not assignees and component organization members can close issues. If you do not
have such privilege, just comment your findings. Otherwise, first `/assign` have such privilege, just comment your findings. Otherwise, first `/assign`
issue to yourself and then `/close`. issue to yourself and then `/close`.
@ -77,7 +77,7 @@ how to address common use cases.
We regularly see messages posted in multiple forums, with the full response We regularly see messages posted in multiple forums, with the full response
thread only in one place or, worse, spread across multiple forums. Also, the thread only in one place or, worse, spread across multiple forums. Also, the
large volume of support issues on github is making it difficult for us to use large volume of support issues on GitHub is making it difficult for us to use
issues to identify real bugs. issues to identify real bugs.
Members of the Kubernetes community use Stack Overflow to field support Members of the Kubernetes community use Stack Overflow to field support
@ -99,10 +99,10 @@ Components are divided among [Special Interest Groups (SIGs)](/sig-list.md). Fin
example. example.
* Multiword SIGs use dashes, for example `/sig cluster-lifecycle`. * Multiword SIGs use dashes, for example `/sig cluster-lifecycle`.
Keep in mind that these commands must be on its own line and at the front of the Keep in mind that these commands must be on their own lines, and at the front of the
comment. comment.
## Validate if the issue is bug ## Validate if the issue is a bug
Validate if the problem is a bug by reproducing it. If reproducible, move to Validate if the problem is a bug by reproducing it. If reproducible, move to
the next step of defining priority. You may need to contact the issue reporter the next step of defining priority. You may need to contact the issue reporter
@ -145,9 +145,9 @@ currently staffed and/or may require multiple releases to complete.
- **priority/backlog**: There appears to be general agreement that this would be - **priority/backlog**: There appears to be general agreement that this would be
good to have, but we may not have anyone available to work on it right now or in good to have, but we may not have anyone available to work on it right now or in
the immediate future. Community contributions would be most welcome in the mean the immediate future. Community contributions would be most welcome in the meantime
time (although it might take a while to get them reviewed if reviewers are fully (although it might take a while to get them reviewed if
occupied with higher priority issues, for example immediately before a release). reviewers are fully occupied with higher priority issues, for example immediately before a release).
- **priority/awaiting-more-evidence**: Possibly useful, but not yet enough - **priority/awaiting-more-evidence**: Possibly useful, but not yet enough
support to actually get it done. These are mostly place-holders for potentially support to actually get it done. These are mostly place-holders for potentially
@ -156,7 +156,7 @@ good ideas, so that they don't get completely forgotten, and can be referenced
## Set ownership ## Set ownership
If you are not sure of who should own issue, defer to the If you are not sure of who should own an issue, defer to the
SIG label only. If you feel the issue should warrant a notification, you can ping SIG label only. If you feel the issue should warrant a notification, you can ping
a team with an @ mention, in this format, `@kubernetes/sig-<group-name>-<group-suffix>`. a team with an @ mention, in this format, `@kubernetes/sig-<group-name>-<group-suffix>`.
Here the `<group-suffix>` can be one of `bugs, feature-requests, pr-reviews, test-failures, proposals`. Here the `<group-suffix>` can be one of `bugs, feature-requests, pr-reviews, test-failures, proposals`.
@ -192,7 +192,7 @@ release.
- **vX.Y**: The list of bugs that will be merged for that milestone once ready. - **vX.Y**: The list of bugs that will be merged for that milestone once ready.
- **vX.Y-candidate**: The list of bug that we might merge for that milestone. A - **vX.Y-candidate**: The list of bugs that we might merge for that milestone. A
bug shouldn't be in this milestone for more than a day or two towards the end of bug shouldn't be in this milestone for more than a day or two towards the end of
a milestone. It should be triaged either into vX.Y, or moved out of the release a milestone. It should be triaged either into vX.Y, or moved out of the release
milestones. milestones.