diff --git a/docs/project/find-an-issue.md b/docs/project/find-an-issue.md index 590795c22d..9ed60bf647 100644 --- a/docs/project/find-an-issue.md +++ b/docs/project/find-an-issue.md @@ -2,7 +2,7 @@ +++ title = "Find and claim an issue" description = "Basic workflow for Docker contributions" -keywords = ["contribute, issue, review, workflow, beginner, expert, squash, commit"] +keywords = ["contribute, issue, review, workflow, beginner, expert, squash, commit"] [menu.main] parent = "smn_contribute" weight=2 @@ -11,7 +11,6 @@ weight=2 # Find and claim an issue -On this page, you choose what you want to work on. As a contributor you can work +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. @@ -61,79 +55,76 @@ for you to know that triage includes ranking issues according to difficulty. Triaged issues have one of these labels: - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
LevelExperience level guideline
exp/beginnerYou have made less than 10 contributions in your life time to any open source project.
exp/noviceYou have made more than 10 contributions to an open source project or at least 5 contributions to Docker.
exp/proficientYou have made more than 5 contributions to Docker which amount to at least 200 code lines or 1000 documentation lines.
exp/expertYou have made less than 20 commits to Docker which amount to 500-1000 code lines or 1000-3000 documentation lines.
exp/masterYou have made more than 20 commits to Docker and greater than 1000 code lines or 3000 documentation lines.
LabelExperience level guideline
exp/beginnerYou have made less than ten contributions in your life time to any open source project.
exp/noviceYou have made more than ten contributions to an open source project or at least 5 contributions to Docker.
exp/proficientYou have made more than five contributions to Docker which amount to at least 200 code lines or 1000 documentation lines.
exp/expertYou have made less than 20 commits to Docker which amount to 500-1000 code lines or 1000-3000 documentation lines.
exp/masterYou have made more than 20 commits to Docker and greater than 1000 code lines or 3000 documentation lines.
-As the table states, these labels are meant as 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 task. +master">exp/master level issue. ## Claim a beginner or novice issue -In this section, you find and claim an open documentation lines issue. - +To claim an issue: 1. Go to the `docker/docker` repository. -2. Click on the "Issues" link. +2. Click the "Issues" link. A list of the open issues appears. ![Open issues](/project/images/issue_list.png) -3. Look for the exp/beginner items on the list. - -4. Click on the "labels" dropdown and select exp/beginner. +3. From the "Labels" drop-down, select exp/beginner. The system filters to show only open exp/beginner issues. -5. Open an issue that interests you. +4. Open an issue that interests you. - The comments on the issues can tell you both the problem and the potential + The comments on the issues describe the problem and can provide information for a potential solution. -6. Make sure that no other user has chosen to work on the issue. +5. When you find an open issue that both interests you and is unclaimed, add a +`#dibs` comment. Make sure that no other user has chosen to work on the issue. - We don't allow external contributors to assign issues to themselves. So, you - need to read the comments to find if a user claimed the issue by leaving a - `#dibs` comment on the issue. + The project does not permit external contributors to assign issues to themselves. Read + the comments to find if a user claimed the issue by leaving a + `#dibs` comment on the issue. -7. When you find an open issue that both interests you and is unclaimed, add a -`#dibs` comment. +7. Your issue # will be different depending on what you claimed. After a moment, Gordon the Docker +bot, changes the issue status to claimed. The following example shows issue #11038. ![Easy issue](/project/images/easy_issue.png) - This example uses issue 11038. Your issue # will be different depending on - what you claimed. After a moment, Gordon the Docker bot, changes the issue - status to claimed. - -8. Make a note of the issue number; you'll need it later. +8. Make a note of the issue number; you will need it for later. ## Sync your fork and create a new branch diff --git a/docs/project/images/issue_list.png b/docs/project/images/issue_list.png index c0aefdb422..0d954986bb 100644 Binary files a/docs/project/images/issue_list.png and b/docs/project/images/issue_list.png differ