From d31e5740bcc6b01447f95826981fac6dbdc9dd00 Mon Sep 17 00:00:00 2001 From: Kilian Folger Date: Wed, 23 Oct 2024 17:25:39 +0200 Subject: [PATCH] Update links to "good first issues" list in index.adoc (#3166) --- .../docs/first-timer-support/index.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/asciidoc-pages/docs/first-timer-support/index.adoc b/content/asciidoc-pages/docs/first-timer-support/index.adoc index 670923e27..cdb67a7e8 100644 --- a/content/asciidoc-pages/docs/first-timer-support/index.adoc +++ b/content/asciidoc-pages/docs/first-timer-support/index.adoc @@ -13,7 +13,7 @@ Therefore it is quite important for us to provide help to people that want to st This documentation is still work in progress and some points that are mentioned are ideas for the future that has not been established yet. ==== -Adoptium provides several issues that are labeled as https://github.com/orgs/adoptium/projects/[good first issue]. +Adoptium provides several issues that are labeled as https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue]. All this issues are perfect to start working on an open source project. The issues provide user friendly descriptions and a lot or helpful links to documentations and tutorials to directly start working on such issue. Even if you are not really familiar with GitHub in general the issues link to user friendly tutorials that will help users to @@ -25,19 +25,19 @@ In GitHub you can find https://github.com/issues?q=org%3AAdoptium+label%3A%22goo == Templates -We are currently working on an issue template for issues that are labeled as a https://github.com/orgs/adoptium/projects/[good first issue]. +We are currently working on an issue template for issues that are labeled as a https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue]. https://gist.github.com/hendrikebbers/8e4dec9ddea5e2a420080d1314af025f[The current version of the issue template] and https://gist.github.com/hendrikebbers/0f9cdd18076343b3bbe5f2d162733b6e[a section about "First timers support" to contributing.md files] are currently in development. == Workflow to create good first issues -Whenever you assume that an issue could be a https://github.com/orgs/adoptium/projects/[good first issue] you should label it with the **`good first issue - candidate`** label. -By doing so it can be reviewed and modified to become a https://github.com/orgs/adoptium/projects/[good first issue] +Whenever you assume that an issue could be a https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] you should label it with the **`good first issue - candidate`** label. +By doing so it can be reviewed and modified to become a https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] In GitHub you can find https://github.com/issues?q=org%3AAdoptium+label%3A%22good+first+issue+-+candidate%22+is%3Aopen[a list of all issues that are labeled by **`good first issue - candidate`**]. -All issues that are labeled as **`good first issue - candidate`** should be reviewed and maybe refactored to become https://github.com/orgs/adoptium/projects/[good first issue] labeled issues. +All issues that are labeled as **`good first issue - candidate`** should be reviewed and maybe refactored to become https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] labeled issues. Here the following rules should be applied: - The title of the issue must specify the problem @@ -45,11 +45,11 @@ Here the following rules should be applied: - The issue should not contain any comments. Comments make it already harder to understand for a newbie. All relevant information that are in the comments should be added to the description of the issue. The comments should be removed afterwards. -If this is not possible the best solution is to create a new issue for the https://github.com/orgs/adoptium/projects/[good first issue], link it to the original one, and close the original one. +If this is not possible the best solution is to create a new issue for the https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue], link it to the original one, and close the original one. - When defining the description of the issue it always makes sense to link to documentations or helpful files (maybe even directly to the code) to help a newcomer to find the right starting point to work on the issue. -Once the issue is refactored and reviewed it should be labeled as https://github.com/orgs/adoptium/projects/[good first issue] and the **`good first issue - candidate`** label should be removed. +Once the issue is refactored and reviewed it should be labeled as https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] and the **`good first issue - candidate`** label should be removed. Next to this we should label all this issues with **`help wanted`** and **`Hacktoberfest`**. == Links & Resources