Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo badges #26

Open
TinoDidriksen opened this issue Mar 5, 2021 · 8 comments
Open

Repo badges #26

TinoDidriksen opened this issue Mar 5, 2021 · 8 comments
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested

Comments

@TinoDidriksen
Copy link
Member

As discussed a bit in apertium/apertium-init#51, we probably want badges for the monolingual and pair repos. But how should they look? Time for bikeshedding!

I've implemented a proof-of-concept https://github.com/apertium/apertium-stats but that's a very thin wrapper around the existing scripts. I don't expect that repo or code to survive, hence why this issue is filed here. E.g., https://github.com/mr-martian/apertium-lint might be a better place for this kind of statistics gathering.

But to get the conversation started properly, I've added this to the nightly builder so that each successful build of a language or pair will yield statistics for that commit and update the badges.

E.g., for apertium-kaz:

For apertium-ote:

For apertium-pt-gl:

All subject to change. Should it look like that? Probably not. Should it be stored there? Absolutely not. Are these the stats we want?

But this works. Adjusting it and storing everything on apertium.org instead is easy. Stuffing the statistics into a service is similarly easy.

@sushain97 @ftyers @unhammer @flammie @IlnarSelimcan @mr-martian @xavivars

@TinoDidriksen TinoDidriksen added enhancement New feature or request help wanted Extra attention is needed question Further information is requested labels Mar 5, 2021
@mr-martian
Copy link
Contributor

The lexc and lexd ones seem awkwardly long to me. The others look good though.

apertium/apertium-lint#2 might also be relevant if there is some question about the proper way to count certain things

@TinoDidriksen
Copy link
Member Author

They are definitely too long, but what's the alternative? Multiple badges? Shorter words?

E.g. lexd: 42 ls (5108 e), 18 ps (35 e) ?

@mr-martian
Copy link
Contributor

I would say probably determine which part of that people care most about and drop the other numbers (which may end up being the same as multiple badges if there's disagreement)

@jonorthwash
Copy link
Member

jonorthwash commented Mar 5, 2021

At first glance, I don't mind how they look. It would be good to get things like coverage or WER in there too, if that's an eventual possibility.

@mr-martian
Copy link
Contributor

Both of those could easily be included in my test framework and thus be available as badges sometime this summer.

@flammie
Copy link
Member

flammie commented Mar 6, 2021

I like the basic stats but definetely coverage / wer too, I also think if we still assume that apertium pairs fall under these: incubator / nursery / release labels and they are useful classification that should be the most useful badge to show.

@TinoDidriksen
Copy link
Member Author

Coverage would be nice.
But badges for things that are already part of Github's UI is superfluous. We have tags that say what release-quality a pair is at.

@flammie
Copy link
Member

flammie commented Mar 8, 2021

But badges for things that are already part of Github's UI is superfluous. We have tags that say what release-quality a pair is at.

My experience is that most users don't know how to look at github's tags at all. tbh most users cannot find the releases either (some even struggle with issues), you basically have to duplicate most of github functions in readme to avoid getting those questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants