diff --git a/docs/workflow/find-an-issue.md b/docs/workflow/find-an-issue.md index 5553e05f5b..40302ae7df 100644 --- a/docs/workflow/find-an-issue.md +++ b/docs/workflow/find-an-issue.md @@ -9,8 +9,11 @@ weight=2 +++ + # Find and claim an issue -On this page, you choose the issue you want to work on. As a contributor, you can work -on whatever you want. If you are new to contributing, you should start by -working with our known issues. +As a contributor, you can work on any open issue you want. You can view +issues in the Issues tab in every repository. If you are new to +contributing, use the filter option to find suitable issues. You can +filter issues by Author, Labels, Milestones, and Assignee or sort by +time such as newest and oldest. ## Understand the issue types +To help you identify the different types of issues, our maintainers +assign labels to issues. Labels are color-coded and help you categorize +and filter issues. There are four labels categories; kind, area, +experience, and priority. You can filter using one or more labels. The +kind and experience labels are useful for new contributors. -An existing issue is something reported by a Docker user. As issues come in, -our maintainers triage them. Triage is its own topic. For now, it is important -for you to know that triage includes ranking issues according to difficulty. +The following table describes the kind labels. +kind/bug -Triaged issues have one of these labels: - - +
- - + + - - + + - - + + - - + + - - + + - - + +
LabelExperience level guidelineKind LabelDescription
exp/beginnerYou have made less than ten contributions in your life time to any open source project.kind/bug + These issues contain bugs. The cause may or may not be known + at triage time so debugging should be taken account into the + time estimate. +
exp/noviceYou have made more than ten contributions to an open source project or at least 5 contributions to Docker. kind/docs + These issues contain documentation, man pages, articles, + blogs, or other significant word-driven task. +
exp/proficientYou have made more than five contributions to Docker which amount to at least 200 code lines or 1000 documentation lines. kind/enhancement + These issues contain enhancements that are not bugs or new + features but can improve usability or performance of + a project component. +
exp/expertYou have made less than 20 commits to Docker which amount to 500-1000 code lines or 1000-3000 documentation lines. kind/feature + These issues contain new features, functionality, and + elements that the project does not currently support. +
exp/masterYou have made more than 20 commits to Docker and greater than 1000 code lines or 3000 documentation lines.kind/question + These issues contain a user or contributor question that + requires a response. +
-These labels are guidelines. You might have written a whole plugin for Docker in a personal -project and never contributed to Docker. With that kind of experience, you could take on an exp/expert or exp/master level issue. -## Claim a beginner or novice issue +The following table describes the experience level guidelines. + + + + + + + + + + + + + + + + + + + + + + + +
Exp LabelDescription
exp/beginner + You are new to Docker and Golang and want to start + contributing to the project. These issues are for beginners who + want to learn the basics. We encourage new contributors to start + with exp/beginner issues. +
exp/intermediate + You understand the core concepts of Docker and are + comfortable with Golang. These issues are for intermediates who + want to dive deeper into the project. +
exp/expert + You are proficient with Docker and Golang and are actively + involved in the community. These issues are for experts who + understand the rationale behind design decisions and where the + project is headed. +
+ +As stated, these labels are guidelines. You might have written a whole +plugin for Docker in a personal project and never contributed to +Docker. With that kind of experience, you could take on an exp/expert issue. + +## Claim a beginner issue To claim an issue: 1. Go to the `docker/docker` repository. -2. Click the "Issues" link. +2. Click the "Issues" tab. A list of the open issues appears.