Labels

This article is about the labels that we are using in our issues. Every one of them has already a short description, but some of them need a bit more explanation.

enhancement vs. bug vs. regression

These three labels implicitly carry a priority behind them: we will usually fix regressions first, then bugs, then take care of enhancements. Of course there is a point where bugs are too minor to be worth our time, so we will not fix every bug before we decide to work on enhancements.

Be aware that some issues may be labeled enhancement instead of bug or vice versa. When there are no clear written agreed specifications of what a feature is supposed to do (which is the case with many features of Tatoeba), the line between a bug and an enhancement is not always obvious.

lang-request

The lang-request label is meant to tag issues requesting to add a new language, or modify a language name or icon. Please have a look at our wiki article about new language requests if you wish to request for a new language.

good first issue

The good first issue label is useful for new members who want to join the development team. It is a standard label for which GitHub offers some extra visibility.

unclear

The issue, its scope or the goal are not clearly identified. More questions or discussion are needed before anyone can start to implement a solution. In order to come up with a good solution, we need clear answers to the following questions:

1. What issue are we trying to solve? Why is it an issue?
2. Who is affected by the issue? In which way(s)?
3. What is the goal? What conditions need to be fulfilled in order to assume that the issue is solved?

Note that this tag also applies to issues labeled as enhancements, because any enhancement needs to solve an actual issue. If we’re just enhancing something for the sake of it, the enhancement might as well not bring any value to anybody, or worse, it might have negative consequences that we’re not foreseeing precisely because of the lack of analysis. Example: adding too many options will eventually clutter the interface.

out-of-scope

There are tons of features we could implement to make Tatoeba an even more awesome tool than it is, but unfortunately, at some point, we have to face the fact that we cannot do everything, neither can we do everything perfectly.

The label out of scope allows us to mark issues that we know we will not be working on at all, or at least not in the foreseeable future. You should not make any pull requests on issues that are labeled out of scope.

The issues will remain open for some time, in case anyone has insights to share and convinces us they are not out of scope after all. Otherwise, we will eventually close them.