Skip to content

Finding a Good Issue: Labels

Beka Westberg edited this page Apr 28, 2020 · 21 revisions

⚠️ 🚧 This page is under construction! 🚧 ⚠️

Talk

This page is meant to explain how issues in this repository are labeled. The plan is to include the label name, a description, and the color. It'll likely look like how terasology handles this. --Beka

Right now this is pretty focussed on people who want to fix bugs, it may need some edits to appeal to people who want to reproduce them --Beka


Lables are a cool feature of GitHub that allow you to filter issues and pull requests. They help you find something fun to work on that fits with your level of experience.

For this repository, adding new labels to issues is handled exclusively by the core team, to make sure that things don't end up in the wrong spot.

➡️ For more information about using labels see Filtering issues and pull requests.

Size

Some issues are bite-sized and beautiful, while others could take weeks to defeat. These labels help you tell how much work an issue will probably take.

Label Description Colour
good first issue These issues are great for people who are new to the repository. They should take less than half a day's work and require limited familiarity with the code base.

Jurisdiction

Working on a widely-used repo can be a sensative process, and some issues can be more dangerous than others. These labels help you tell which issues are are open for contribution, and which issues to steer clear of.

Label Description Colour
help wanted These issues are reserved for contributors. Often they are features the core team think would be useful, but don't have time to implement. This is a good place to find fun creative projects!
internal These issues are reserved for members of the core team. Often they are sensative or complex bugs that need special discussion. It's best to steer clear of these because the situation around them can change rapidly!
neither Issues that have neither label can be fixed by contributors and members of the core team. If you see an unlabeled issue that seems interesting to you, go ahead and take it!

Type

Different issues require different responses. Some only require editing a few lines of code, while others need lots of design and discussion. These labels tell you what kind of issue an issue is, at a glance.

Label Description Colour
bug These issues document a problem with the codebase. They often take some debugging to diagnose what's causing the problem, but some can be fixed in a wink. If you like digging deep to learn how the code ticks, these will be great issues for you.
feature request These issues document a feature that someone would like to be added. These can apply to the repository as a whole, or
question

Category

Label Description Colour
codelab
example
plugin

Project

Label Description Colour
dev tools
field date
field slider
plugin workspace search

Other

Label Description Colour
triage
duplicate

Clone this wiki locally