Language resource maturity classification

There is a need to clearly communicate the maturity of a language resource code base. For this four categories are used (+ unknown/undefined), as defined below:

1. Production - colour: green
2. Beta - colour: yellow
3. Alpha - colour: red
4. Experiment / student exercise - colour: black
5. Undefined - colour: grey

These categories are used as labels in README files, on the documentation front page for each resource, as well as in the registry. The labels should look as follows:

• 
• 
• 
• 
• 

Maturity class definitions (in reverse order)

The criterias for the various levels (some of these criterias do not apply to keyboards, for obvious reasons) are:

Undefined

Used when the maturity is not definable, or has not yet been defined/tagged.

Experiment

This category also covers student exercises (published with permission). The point of such exercises is not to make a working system, but to explore the possibilities for language technology. Such work can of course be extended and in the end result in a fully working, production tool.

• license not required, but is nice
• fragmentary grammar/model/layout
• less than 1k lexical entries
• may not build at all
• Divvun Manager:
  • might not be available
  • only available in the nightly channel

Alpha

• license highly recommended
• grammar/model/layout mostly complete
• lexicon between 1k and 10k entries
• Divvun Manager:
  • is available
  • only available in the nightly channel
• rule of thumb: it can be built locally and used for something

Beta

• there should be a proper license
• grammar/model/layout complete
• lexicon has more than 10k entries
• running text coverage above 80 %
• CI/CD working for the tools being provided
• Divvun Manager:
  • is available
  • is available in the stable channel
  • NOT visible on the front page, only via the All languages view
• rule of thumb: it can easily be installed via Divvun Manager - it must be testable by the user community

Production

• there must be a proper license
• grammar/model/layout complete
• lexicon has more than 30k entries (but subject to realworld realities & limits)
• running text coverage above 90 %
• at least one contact person in the language community that is willing to or being payed to be a first line support person and language resource maintainer, public contact email or other contact info
• CI/CD working for the tools being provided
• Divvun Manager:
  • is available
  • is available in the stable channel
  • IS visible on the front page
• Release 1.0.0 or higher of either speller or analyser/giella-XXX package
• rule of thumb: it is easily installable via the One-click installer or Divvun Manager front page

Registering maturity

Maturity badges in README’s, documentation and the registry are presently maintained manually. But the maturity level is also used to group languages automatically in the keyboard and language resource lists, in which case it is taken automatically from a correesponding topic tag in the github repo. Over time, all instances of maturity badges should be generated from these topic tags.

Adding maturity topic tags

Adding maturity tags is done via GitHub topics, and can only be done by repo or organisation owners or admins. The topic tags corresponding to the labels above are as follows:

• maturity-prod -
• maturity-beta -
• maturity-alpha -
• maturity-exper -

The category is of course unlabeled - that is the definition of the category. It should ideally be empty.