Labels used for issues
This repo uses a set of labels to help the team prioritizing the work in various areas.
Bugs are described by the following label:
Some bugs can be further categorized:
| Label | Description |
|---|---|
| Reliability | Issues that causes the service to crash or become unstable. |
| Security | Issues that causes security or privacy problem. |
| Telemetry | The ability to collect telemetry is broken or missing. |
Some issues require higher priorities than others.
If the issue is blocking and there is no known workaround, then urgent label will be used to indicate that the issue takes priority over any other work and ideally it will be resolved within 24 hours.
If there is a workaround but the issue is painful, then soon label will be used.
If the issue is resolved without any resolution label, then it can be assumed that the issue is fixed. However, if the issue is not fixed, then one of the following labels should be used.
| Label | Description |
|---|---|
| Duplicate | The issue already exists. |
| Not Reproducible | The issue could not be reproduced. |
| Won't fit | The issue will not be fixed. |
Each issue is assigned to one of the following areas by our internal triage team. Only one area should be assigned per issue. If the issue crosses multiple boundaries, then a separate issue should be created and tracked.
Certain issues are not bugs but rather enhancements, in which case the enhancements labels are used.
| Label | Description |
|---|---|
| Optimization | Something could be optimized. |
| Refactor | The code should be refactored. |
| Test | Test enhancements. |
Sometimes progress is blocked due to waiting for another code change, or on customer feedback, or something that is not under the control of the assignee. The issue should contain an explanation as to why it is blocked.
Documentation is an important part of the project and should be tracked as an issue just like bugs. This label should be applied on a separate issue that tracks the documentation of a feature or a bug and should contain links to that issue.
Help from the wonderful, amazing, and intelligent community is always appreciated. These issues require minimum context and are well-suited for the new contributors.
