Skip to content

Commit

Permalink
Ymse forbetringar i teksten, oppdaterte lenker
Browse files Browse the repository at this point in the history
  • Loading branch information
snomos committed Oct 2, 2023
1 parent fc0eca7 commit 0c3df65
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions MaturityClassification.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 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:
In the GielllaLT infrastructure we use the following classification to broadly describe the quality and development level of various linguistic resources:

1. Production - colour: green
1. Beta - colour: yellow
1. Alpha - colour: red
1. Experiment / student exercise - colour: black
1. 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](https://github.com/divvun/registry). The labels should look as follows:
These categories are used as labels in README files, on the documentation front page for each resource, as well as in the overview pages for [language models](LanguageModels.md) and [keyboards](KeyboardLayouts.md). The labels should look like the following:

* ![Maturity: Production](https://img.shields.io/badge/Maturity-Production-brightgreen.svg)
* ![Maturity: Beta ](https://img.shields.io/badge/Maturity-Beta-yellow.svg)
Expand Down Expand Up @@ -76,7 +76,9 @@ This category also covers student exercises (published with permission). The poi

# Registering maturity

Maturity badges in README's, documentation and elsewhere generated automatically from GitHub topics. These topics are also used in the [keyboard](keyboards/KeyboardLayouts.md) and [language resource](LanguageModels.md) lists to group the repos automatically.
The maturity classification is done using GitHub topics.

Maturity badges in README's, documentation and elsewhere are generated automatically from these topics, and they are also used in the [keyboard](keyboards/KeyboardLayouts.md) and [language resource](LanguageModels.md) lists to group the repos automatically.

## Adding maturity topic tags

Expand All @@ -89,8 +91,8 @@ The topic tags corresponding to the labels above are as follows:
* `maturity-alpha` - ![Maturity: Alpha ](https://img.shields.io/badge/Maturity-Alpha-red.svg)
* `maturity-exper` - ![Maturity: Experiment](https://img.shields.io/badge/Maturity-Experiment-black.svg)

The ![Maturity: Undefined ](https://img.shields.io/badge/Maturity-Undefined-lightgrey.svg) category does of course not have a topic - that is the definition of the category. It should ideally be empty, but is listed on the above pages to easily spot repositories that do not yed have a defined maturity class.
The ![Maturity: Undefined ](https://img.shields.io/badge/Maturity-Undefined-lightgrey.svg) category does of course not have a topic - that is the definition of the category. In the lists and tables linked to above it should ideally be empty, but it is listed in any case to easily spot repositories that do not yet have a defined maturity class.

The maturity tags are turned into `json` endpoints for [shield.io](https://shield.io), and stored in the `gh-pages` branch of each repository. This is done automatically by the CI on each push to GitHub, but requires that GitHub Pages have been configured for the repo.

There should be only ONE maturity tag pr repo. — It is possible to add more maturity tags to a single repo, but that does not make much sense and will probably cause the `json` file creation to fail.
There should be only ONE maturity tag pr repo. — It is technically possible to add more maturity tags to a single repo, but that does not make much sense and will probably cause the `json` file creation to fail.

0 comments on commit 0c3df65

Please sign in to comment.