Skip to content

Issue Labelling System

Luo Chen edited this page Feb 10, 2018 · 26 revisions

Label Descriptions

A - Activity

(Colour: #fbca04)

This category represents issues that are under consideration or actively worked on.

Label Description 
A-Confirmed Issue confirmed and needs to be fixed
A-In Progress  Issue is actively being worked on, but not completed
A-Under Review Pull request is finished and waiting for review 
A-Paper Cut Issues with non-surprising behaviour for developers, but may surprise or annoy users

C - Contribution

(Colour: #006b75)

This category represents issues where external contributions are more than welcome.

Label Description
C-Low Hanging Fruit Tasks which are especially suitable for new contributors
C-Minor Effort Tasks which are suitable for contribution, and are not expected to require major effort
C-Moderate Effort Tasks which are suitable for contribution, with moderate effort required
C-Major Effort Tasks which require major work, often the size of a project

F - Feedback

(Colour: #bebe00)

This category represents issues that are primarily procedural or non-specific to the codebase.

Label Description
F-Discussion  Feedback focused on discussing a particular aspect of the Idris language or libraries
F-Meta Feedback focused on meta-procedural issues such as organisation of repository or process
F-Question Clarification regarding an unclear aspect of the language
F-Request for Comment Feedback requested on a concrete code patch or documentation change

G - Code Generators

(Colour: #c5def5)

This category represents issues that relate to the code generation framework or one of the various code generators.

Label Description
G-Intermediate Representation An issue regarding compilation or translation between IRs
G-C Backend An issue that is present when generating or compiling C code
G-ECMAScript Backend An issue that is present when generating or compiling ECMAScript code
G-Other Backend An issue that is present with an external code generator

I - Inactive

(Colour: #aaaaaa)

This category represents issues that are not actively being worked on, due to e.g. lack of resources or missing information.

Label Description
I-Abandoned Code has not been actively worked on for a long time
I-Duplicate Issue already exists
I-Expected Behaviour Reported issue works as intended
I-Information Needed There is not enough information to fix the issue
I-Not Reproducible Issue does not appear in developer's environment
I-Potentially Fixed Issue appears to be fixed, but not confirmed to be so by reporter
I-Won't Fix Issue is not going to be worked on due to lack of resources or design incompatibility

P - Platform

(Colour: #5319e7)

This category represents different platforms which Idris supports.

Label Description
P-BSD Issue appears on BSD
P-Linux Issue appears on Linux
P-OS X Issue appears on OS X
P-Windows Issue appears on Windows
P-Other Issue appears on other types of systems like BSD, Android, or Embedded

S - Severity

(Colour: red scale)

This category partitions issues into levels of severity.

Label Description
S-Critical A severe bug which should be fixed as soon as possible, preferably before next release
S-Normal An ordinary bug which should be fixed when time is available
S-Cleanup An improvement on the code base which is nice to have

U - Usability

(Colour: #d4c5f9)

This category describes issues that concern usability of language front-end, documentation or libraries.

Label Description
U-Documentation Missing or unclear documentation
U-Library design Design issue in a part of the provided libraries
U-Pretty Printer Prettied text is not as intended or could be more readable
U-Error Message Shown error message is wrong or lacks necessary information, which makes it hard to fix the underlying error
U-Totality Checking Issues regarding totality checking in Idris, including coverage, termination and productivity
U-Type Checking Usability issues during type checking
U-Elaboration Terms or definitions are not elaborated as expected
U-Build System Suggestion for improvement of the build process
U-Parser Parsing does not work as intended
U-Editor support Issues with interactive editing commands or the process that provides editor support
U-Foreign Function Interface Issues relating to definition of or interaction with foreign functions
U-Interactive Issues with interactive evaluation and the REPL
U-Inconsistency An inconsistency in the type system, e.g., a proof of Void
U-Package Management Issues or ideas to improve the package handling system and package design
U-Surprising Behaviour A language construct or features does not act as one would expect
U-Literate Mode Any issue that concerns the literate mode support in Idris
U-Domain Specific Languages Improvements or missing functionality regarding Idris features that enables writing nice embedded DSLs
U-Reflection Issues or improvements regarding pattern-matching based reflection mechanism (%reflection)
U-Module System Issues regarding design or organization of modules and the module fetching mechanism

W - Work

(Colour: #c2e0c6)

This category concerns a particular aspect of development that needs to be used to solve the problem.

Label Description
W-Testing Issues concerning addition or modification of test suite
W-Debugging Issues that require comprehensive debugging
W-Profiling Issues that concern finding memory leaks or severe performance slowdowns
W-Refactoring Issues that regard larger proposed refactorings of the project

X - Extensions

(Colour: #444444)

This category concerns language extensions or experimental features.

Label Description
X-Elaborator Reflection  Issues with the Elaborator Reflection
X-Type Providers Issues with Type Providers
X-Experimental Issues with Experimental Features

Z - Enhancements

(Colour: #0e8a16)

This category describes suggestions for non-essential improvements to the language.

Label Description
Feature Request Request for a feature that provides additional convenience or expressiveness
Optimization Request for improvement of performance or memory usage for a part of the system

Inspiration

The labelling system has been inspired by practices outlined in https://robinpowered.com/blog/best-practice-system-for-organizing-and-tagging-github-issues/ and issue labelling in Rust

Clone this wiki locally