|
1 | 1 | # Introduction
|
2 | 2 |
|
3 |
| -This document describes Kubernetes Dashboard issues categorization and |
4 |
| -prioritization. |
| 3 | +This document describes Kubernetes Dashboard issues categorization and prioritization. |
5 | 4 |
|
6 | 5 | ## Priorities
|
7 | 6 |
|
8 |
| -Kubernetes Dashboard uses labels to mark GitHub issues with priorities. |
9 |
| -Every issue should have assigned priority, absence of priority label |
10 |
| -means, that issue has not been checked yet. If you do not agree with |
11 |
| -assigned priority, then please notify about it. |
| 7 | +Kubernetes Dashboard uses labels to mark GitHub issues with priorities. Every issue should have assigned priority, absence of priority label means, that issue has not been checked yet. If you do not agree with assigned priority, then please notify about it. |
12 | 8 |
|
13 | 9 | ### Priority labels
|
14 | 10 |
|
15 |
| -- `priority/P0` - critical issue, that must be resolved as soon as |
16 |
| -possible. Someone must be working on it. It can be broken build, crucial |
17 |
| -security issue or bug causing application crashes. |
18 |
| -- `priority/P1` - important issue, that needs to be resolved before next |
19 |
| -release. It can be important feature or a bug, which is visible for |
20 |
| -users. |
21 |
| -- `priority/P2` - issue, that should be resolved soon. It can be |
22 |
| -feature, bug or anything else, which is not top priority at the moment. |
23 |
| -- `priority/P3` - lower priority issue, that will be resolved after |
24 |
| -issues with higher priority. It can be minor enhancement, which is not |
25 |
| -required at the moment. |
| 11 | +- `priority/P0` - critical issue, that must be resolved as soon as possible. Someone must be working on it. It can be broken build, crucial security issue or bug causing application crashes. |
| 12 | +- `priority/P1` - important issue, that needs to be resolved before next release. It can be important feature or a bug, which is visible for users. |
| 13 | +- `priority/P2` - issue, that should be resolved soon. It can be feature, bug or anything else, which is not top priority at the moment. |
| 14 | +- `priority/P3` - lower priority issue, that will be resolved after issues with higher priority. It can be minor enhancement, which is not required at the moment. |
26 | 15 |
|
27 | 16 | ## Categories
|
28 | 17 |
|
29 |
| -Kubernetes Dashboard uses labels to mark GitHub issues with categories. |
30 |
| -Every issue should be categorized, absence of category label means, that |
31 |
| -issue has not been checked yet. If you do not agree with assigned |
32 |
| -category, then please notify about it. |
| 18 | +Kubernetes Dashboard uses labels to mark GitHub issues with categories. Every issue should be categorized, absence of category label means, that issue has not been checked yet. If you do not agree with assigned category, then please notify about it. |
33 | 19 |
|
34 | 20 | ### Area labels
|
35 | 21 |
|
36 |
| -Issue area determines part of application or process connected to it. |
37 |
| -It can be API, documentation, internationalization, tests etc. Areas |
38 |
| -would be different for each application, Kubernetes Dashboard uses: |
| 22 | +Issue area determines part of application or process connected to it. It can be API, documentation, internationalization, tests etc. Areas would be different for each application, Kubernetes Dashboard uses: |
39 | 23 |
|
40 | 24 | - `area/api` - issues connected to API of the Kubernetes Dasboard.
|
41 |
| -- `area/dev` - issues connected to development tools, processes and |
42 |
| -configuration. |
43 |
| -- `area/docs` - issues connected to documentation of the Kubernetes |
44 |
| -Dashboard. |
45 |
| -- `area/i8n` - issues connected to internationalization and |
46 |
| -localization. |
47 |
| -- `area/install` - issues connected to build and installation process |
48 |
| -of the Kubernetes Dashboard. |
| 25 | +- `area/dev` - issues connected to development tools, processes and configuration. |
| 26 | +- `area/docs` - issues connected to documentation of the Kubernetes Dashboard. |
| 27 | +- `area/i8n` - issues connected to internationalization and localization. |
49 | 28 | - `area/performance` - issues connected to performance.
|
| 29 | +- `area/security` - issues connected to security and authorization. |
| 30 | +- `area/setup` - issues connected to build and installation process of the Kubernetes Dashboard. |
50 | 31 | - `area/styling` - issues connected to styling of Kubernetes Dashboard.
|
51 | 32 | - `area/tests` - issues connected to tests.
|
52 |
| -- `area/usability` - issues connected to general usability of Kubernetes |
53 |
| -Dashboard. |
| 33 | +- `area/usability` - issues connected to general usability of Kubernetes Dashboard. |
| 34 | +- `area/ux` - issues connected to user experience topics. |
54 | 35 | - `area/validation` - issues connected to form validation processes.
|
55 | 36 |
|
56 | 37 | ### Kind labels
|
57 | 38 |
|
58 |
| -Issue kind determines if issue is a bug, enhancement, feature, |
59 |
| -refactoring of existing code or if it covers changes in Kubernetes API. |
60 |
| -In contrast to area it is not connected to application itself. Following |
61 |
| -kinds could be applied to most of the applications. |
| 39 | +Issue kind determines if issue is a bug, enhancement, feature, refactoring of existing code or if it covers changes in Kubernetes API. In contrast to area it is not connected to application itself. Following kinds could be applied to most of the applications. |
62 | 40 |
|
63 |
| -- `kind/api change` - issues created in order cover API changes in |
64 |
| -the Kubernetes. |
65 | 41 | - `kind/bug` - bugs, that need to be fixed.
|
66 |
| -- `kind/enhancement` - issues created in order to make the application |
67 |
| -better. |
68 |
| -- `kind/feature` - issues created in order to add new features to the |
69 |
| -application. |
70 |
| -- `kind/refactoring` - issues created in order to enhance code quality |
71 |
| -without changing application functionality. |
| 42 | +- `kind/enhancement` - issues created in order to make the application better. |
| 43 | +- `kind/feature` - issues created in order to add new features to the application. |
| 44 | +- `kind/question` - discussion issues and user questions. |
| 45 | +- `kind/refactoring` - issues created in order to enhance code quality without changing application functionality. |
72 | 46 |
|
73 | 47 | ### CLA labels
|
74 | 48 |
|
75 |
| -Kubernetes Dashboard uses following two labels to mark pull requests. |
76 |
| -Every contributor needs to sign CLA before his change can be merged. |
77 |
| -Both labels are assigned automatically by @googlebot. |
| 49 | +Kubernetes Dashboard uses following two labels to mark pull requests. Every contributor needs to sign CLA before his change can be merged. Both labels are assigned automatically by @googlebot. |
78 | 50 |
|
79 | 51 | - `cla: yes` - CLA signed.
|
80 | 52 | - `cla: no` - CLA not signed yet.
|
81 | 53 |
|
82 | 54 | ### Other labels
|
83 | 55 |
|
84 |
| -- `duplicate` - duplicated issues, that are usually closed and linked |
85 |
| -with original issue. |
86 |
| -- `help wanted` - issues, where any contributions are appreciated. |
87 |
| -- `invalid` - invalid issues. Not real bugs reported by users or issues |
88 |
| -with invalid description. |
89 |
| -- `missing details` - issues with missing details. Issue template should |
90 |
| -be followed to avoid it. |
91 |
| -- `question` - discussion issues and user questions. |
92 |
| -- `wont fix` - issues, that will not be fixed. |
| 56 | +- `duplicate` - duplicated issues, that are usually closed and linked with original issue. |
| 57 | +- `greenkeeper` - pull requests created by [greenkeeper.io bot](https://github.com/greenkeeperio-bot). This label is assigned automatically. |
0 commit comments