-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Labels
Ilya Buziuk edited this page Jul 8, 2024
·
40 revisions
The Eclipse Che project relies heavily on issue labels as a way to communicate status and responsibility.
Note: this page only documents SOME of the most used labels in the Eclipse Che project.
The following labels are for issues and pull requests that new contributors can start with. The corresponding issues appear in the Contribute page.
| Label | Description |
|---|---|
good first issue |
Community, this issue looks easy to start with for a new contributor. Just take it. We'll help you! |
help wanted |
Community, our teams are fully engaged on other issues. Feel free to take this one. We'll help you! |
| Label | Description |
|---|---|
kind/question |
Questions that haven't been identified as being feature requests or bugs. |
kind/enhancement |
A feature request - must adhere to the feature request template. |
kind/epic |
A long-lived, PM-driven feature request. Must include a checklist of items that must be completed, which can reference enhancements or bugs. |
kind/story |
A description of a feature or functionality desired in the project written from the perspective of the end user (e.g. as a user...), focusing on what they want to achieve and why it's important to them. |
kind/bug |
Outline of a bug - must adhere to the bug report template. If a bug is identified during a question investigation a new issue can be created for the bug and the question closed. |
kind/task |
Internal things, technical debt, and to-do tasks to be performed. |
kind/docs |
A work item tied to documentation. |
kind/planning |
A checklist of issues that a team is planning for a particular sprint. |
kind/usability |
Issues related to the end-user experience. |
Issues related to a specific functional area of Che (e.g. che-server, dashboard, install, editors).
| Label | Description |
|---|---|
severity/blocker |
Causes a system to crash and be non-recoverable or prevents Che developers from working on Che code. Must be resolved immediately. Can only be applied to kind/bugs. |
severity/P1 |
Has a major impact to usage or development of the system. Issues / PRs with P1 status should be prioritized during sprint planning. Can be applied to all kinds of issues. Not all issues need a severity. If an enhancement or bug will take >1 sprint to address consider using the roadmap/* labels instead. |
severity/P2 |
Has a minor but important impact to the usage or development of the system. Should be considered when planning sprints. Can be applied to all kinds of issues. Not all issues need a severity. If an enhancement or bug will take >1 sprint to address consider using the roadmap/* labels instead. |
severity/P3 |
Lowest priority issue. Optional work. See also help wanted issues |
help wanted |
As with P3 issues, this is work that no one is currently tracking. Feel free to take this one. We'll help you! |
| Label | Description |
|---|---|
level/beginner |
A relatively easy issue that's well suited to being addressed by a pull request from the community. |
level/intermediate |
A more advanced issue that is open to a pull request from a community member with more experience in Che. |
level/advanced |
A challenging issue that is complicated and needs help from a community member with domain experience. |
| Label | Description |
|---|---|
status/need-triage |
An issue that needs to be prioritized by the triage team. |
status/info-needed |
More information is needed before the issue can move into the “analyzing” state for engineering. |
status/analyzing |
An issue has been proposed and is currently being analyzed for effort and implementation approach. |
status/open-for-dev |
An issue has had its specification reviewed and confirmed. Waiting for an engineer to accept the issue and take it into active development. |
status/in-progress |
This issue has been taken by an engineer and is under active development. |
status/code-review |
This issue has a pull request posted for it and is awaiting code review completion by the community. |
status/doc-impact |
This issue has an impact on documentation, it is required to provide a documentation update. |
status/blocked |
Issue that can’t be moved forward. Must include a comment on the reason for the blockage. If it’s blocked because it depends on another issue then it should include a link to the issue it depends on. |
| Label | Description |
|---|---|
lifecycle/stale |
Indicates an issue or PR has remained open with no activity and has become stale. |
lifecycle/frozen |
Indicates that an issue or PR should not be auto-closed due to staleness. |
lifecycle/rotten |
Denotes an issue or PR that has aged beyond stale and will be auto-closed. |
lifecycle/active |
Indicates that an issue or PR is actively being worked on by a contributor. |
| Label | Description |
|---|---|
sprint/current-sprint |
Issue is being worked in the current sprint. |
sprint/next-sprint |
Issue is planned to be worked in the next sprint. |
| Label | Description |
|---|---|
team/A |
Issue to be taken by Team A |
team/B |
Issue to be taken by Team B |
| Label | Description |
|---|---|
target/branch |
Indicates that a PR will be merged into a branch other than main. When merging to main branch target/ label should not be used as it is an assume default target for most PRs. |
| Label | Description |
|---|---|
e2e-test/failure |
Issues that is related to test failures reported by the CI platform or the QE team. |