Spec: Introduce Community Health Score panel - #4367
Conversation
mathjazz
changed the title
mathjazz
changed the title
mathjazz
changed the title
There was a problem hiding this comment.
This sadly still needs quite a lot of work.
Lots of content is out of date and incoherent.
I would also find it much easier to read in prose, than in several nesting levels of bullet points. See other specs for reference.
Should we cover the the report system (PR #4336) here as well?
Please also add screenshots.
mathjazz
changed the title
|
Phew, lots of reviews :/
Let's not do that, I was thinking of making a seperate spec for that |
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
| - `active_managers_score`: score representation of `active_managers` | ||
| - `active_translators_score` score representation of `active_translators` | ||
| - `active_contributors_score` score representation of `active_contributors` | ||
| - `all_contributors_score` score representation of `all_contributors` | ||
| - `new_signups_score` score representation of `new_signups` | ||
| - `key_projects_enabled_score` score representation of `key_projects_enabled` | ||
| - `completion_score` score representation of `completion` |
There was a problem hiding this comment.
This paragraphs doesn't add much value. Instead, we should explain the formula for calculating each of these scores.
Think of the spec as the containing sufficient information to develop the feature. It will also be helpul in the future when we'll need to understand how the score works, so we don't need to decypher the code.
| - `key_projects_enabled_score` score representation of `key_projects_enabled` | ||
| - `completion_score` score representation of `completion` | ||
|
|
||
| Finally the scores are combined into a **Community health score** for that locale on that month which is used for measuring locale health. |
There was a problem hiding this comment.
How excatly (mathematically) are they combined?
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
mathjazz
left a comment
mathjazz
left a comment
There was a problem hiding this comment.
Left some more inline comments.
We should fix that reference to the "following scores" ans "thresholds" and we can land this.
| - `key_projects_enabled`: number of projects that are classified as key projects via the `is_chs_project` flag | ||
| - `completion`: locale completion, as a percentage of (**approved strings** + **strings with warnings**) out of **total strings** | ||
|
|
||
| The data used is then computed into the following scores based on predetermined thresholds. Finally the scores are summated to a **Community health score** for that locale on that month which is used for measuring locale health. |
There was a problem hiding this comment.
What following scores and what thresholds?
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
| - `key_projects_enabled`: Number of projects that are classified as key projects via the `is_chs_project` flag. | ||
| - `completion`: Locale completion, expressed as a percentage of **approved strings** + **strings with warnings** out of **total strings**. | ||
|
|
||
| The data used is then computed into scores based on predetermined metric thresholds, which are set as environment variables for admin customization. Finally the scores are summated to a **Community health score** for that locale on that month which is used for measuring locale health. |
There was a problem hiding this comment.
Imagine you are a dev, presented with this spec. This information is insufficient for implementation of the computation of the scores. We should list the environment variables in question and describe the formula / algorithm for the calculation of the score.
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
mathjazz
left a comment
mathjazz
left a comment
There was a problem hiding this comment.
Excellent, now it all makes sense!
2 participants
This PR copies internal specs for the Insights dashboard for github access.