diff --git a/content/contributing-code/repo-labels/contents.lr b/content/contributing-code/repo-labels/contents.lr index de0494d1c..b52612c9a 100644 --- a/content/contributing-code/repo-labels/contents.lr +++ b/content/contributing-code/repo-labels/contents.lr @@ -4,13 +4,16 @@ _template: page-with-toc.html --- title: Repository Labels --- -description: To facilitate the community in finding ways to contribute that match their experiences and skillsets, we have developed a comprehensive system for labelling issues and PRs. This is an introduction to this standard labelling scheme. +description: To facilitate the community in finding ways to contribute that +match their experiences and skillsets, we have developed a comprehensive system +for labelling issues and PRs. This is an introduction to this standard +labelling scheme. --- body: -Labels consist of three fields, viz. name, description and color. Label names -should have a consistent format to aid both filtering within the github UI as -well as scanning visually through the list. The following format is the most +Labels consist of three fields, viz. name, description and color. Label names +should have a consistent format to aid both filtering within the github UI as +well as scanning visually through the list. The following format is the most suited to this task (where `โŽต` denotes a single space): ``` @@ -31,6 +34,7 @@ An issue has many different attributes: - Talk - Friendliness + ### *Priority
@@ -59,8 +63,8 @@ An issue has many different attributes:
-The priority of an issue is based on its impact, derived from a combination of -urgency and importance. This determines the importance of the issue when sprint +The priority of an issue is based on its impact, derived from a combination of +urgency and importance. This determines the importance of the issue when sprint planning or deciding which issues to tackle next. - @@ -80,6 +84,7 @@ planning or deciding which issues to tackle next. - **Description:** Low priority and doesn't need to be rushed + ### *Status
@@ -112,32 +117,24 @@ The status of the issue determines whether it is ready for work or not. Issues may not be ready to be worked on for a number of reasons and the maintainers must keep updating the labels as the situation evolves. -An issue, at the time of closing can have either the +An issue, at the time of closing can have either the ๐Ÿ status: ready for dev -or the +or the โ›”๏ธ status: discarded label based on whether it was closed with or without resolution, respectively. -- - ๐Ÿ status: ready for dev +- + ๐Ÿšฆ status: awaiting triage - - **Description:** Ready for work + - **Description:** Has not been triaged & therefore, not ready for work - ๐Ÿšง status: blocked - **Description:** Blocked & therefore, not ready for work -- - ๐Ÿงน status: ticket work required - - - **Description:** Needs more details before it can be worked on -- - ๐Ÿท status: label work required - - - **Description:** Needs proper labelling before it can be worked on - โ›”๏ธ status: discarded @@ -146,10 +143,19 @@ label based on whether it was closed with or without resolution, respectively. ๐Ÿ™… status: discontinued - **Description:** Not suitable for work as repo is in maintenance -- - ๐Ÿšฆ status: awaiting triage +- + ๐Ÿท status: label work required - - **Description:** Has not been triaged & therefore, not ready for work + - **Description:** Needs proper labelling before it can be worked on +- + ๐Ÿ status: ready for dev + + - **Description:** Ready for work +- + ๐Ÿงน status: ticket work required + + - **Description:** Needs more details before it can be worked on + ### *Goal @@ -158,10 +164,11 @@ represents the impact of the issue on the scope of the software. - โญ goal: addition - **Description:** Addition of new feature -- โœจ goal: improvement - - **Description:** Improvement to an existing feature - ๐Ÿ›  goal: fix - **Description:** Bug fix +- โœจ goal: improvement + - **Description:** Improvement to an existing feature + ### *Aspect @@ -169,43 +176,48 @@ The aspect of an issue is the side of the project that the issue deals with. A single codebase can have multiple aspects to it and knowing which ones will be touched helps contributors find relevant issues. -- ๐Ÿ“„ aspect: text - - **Description:** Concerns the textual material in the repository - ๐Ÿ’ป aspect: code - **Description:** Concerns the software code in the repository -- ๐Ÿ•น aspect: interface - - **Description:** Concerns end-users' experience with the software +- ๐Ÿ“– aspect: docs + - **Description:** Concerns the documentation in the repository - ๐Ÿค– aspect: dx - **Description:** Concerns developers' experience with the codebase +- ๐Ÿ•น aspect: interface + - **Description:** Concerns end-users' experience with the software +- ๐Ÿ“„ aspect: text + - **Description:** Concerns the textual material in the repository + ### Skill -The technical skills a person is required to possess to work on the issue. +The technical skills a person is required to possess to work on the issue. Skills are a special type of label that vary by repository. Issues may not have a skill tag if no special skills are required. - ๐Ÿ’ช skill: <skill name> - **Description:** Requires proficiency in '<skill name>' + ### Talk Issues with interaction labels do not entail any work to be done on the -repository. They are for Q&A, RFCs and any other form of discussions. While both -of these may appear to be too similar, triage permissions are granted to +repository. They are for Q&A, RFCs and any other form of discussions. While +both of these may appear to be too similar, triage permissions are granted to collaborators who might not have the answers to questions but by labelling them as such, they might draw a faster response from an experienced contributor who -does. _In the future this category might be rendered redundant by GitHub +does. _In the future this category might be rendered redundant by GitHub Discussions and will be removed._ -- โ“ talk: question - - **Description:** Can be resolved with an answer - ๐Ÿ’ฌ talk: discussion - **Description:** Open for discussions and feedback +- โ“ talk: question + - **Description:** Can be resolved with an answer + ### Friendliness -The level of friendliness a particular issue is the valency of the issue -towards contributions from the community. Some issues provide a great +The level of friendliness a particular issue is the valency of the issue +towards contributions from the community. Some issues provide a great introduction while others require a little more familiarity with the codebase. _These issues do not have the category prefix as two of them are special labels recognized by GitHub. The special ones don't have emojis either._ @@ -217,28 +229,26 @@ recognized by GitHub. The special ones don't have emojis either._ - ๐Ÿ”’ staff only - **Description:** Restricted to CC staff members + ### Miscellaneous - ๐Ÿคฏ ใƒŽเฒ ็›Šเฒ ใƒŽๅฝกโ”ปโ”โ”ป - **Description:** Aaargh! -- - Hacktoberfest - - - **Description:** Good issues for Hacktoberfest participants - invalid - **Description:** Inappropriate or invalid (ex. Hacktoberfest spam) + ## Usage rules In the above categories, some are marked with an `*` sign. Those are mandatory categories and every issue is required to have at least one label from those categories. -Only issues labelled with +Only issues labelled with ๐Ÿšฆ status: awaiting triage @@ -246,4 +256,4 @@ are allowed to not have all mandatory labels (seeing as they have not been triaged yet). Categories not marked with an `*` are optional and it is upto the discretion of -the maintainers to have apply labels from those categories to issues. \ No newline at end of file +the maintainers to have apply labels from those categories to issues.