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

Provide a “pass/fail” status and badge #9

Open
AndyClifton opened this issue Oct 9, 2020 · 3 comments
Open

Provide a “pass/fail” status and badge #9

AndyClifton opened this issue Oct 9, 2020 · 3 comments

Comments

@AndyClifton
Copy link

Great tool! It would really help if the SKOS testing tool could generate a simple pass / fail result from the test that could in turn be used to generate a shields.io badge. These are really useful for showing the user a status of their .ttl file, for example.

@tfrancart
Copy link
Collaborator

That badge idea is nice. However, not all Knowledge Organization Systems have the same requirements; for example sometimes it is OK to have homonyms, sometimes not. Sometimes you know you miss some translations, etc. The test tool results is not as simple as a pass/fail status and sometimes need to be interpreted with case.

To explore the idea, could you suggest a format for the result as I am not familiar with shields.io ?

Thanks for the comment

@AndyClifton
Copy link
Author

AndyClifton commented Oct 16, 2020

http://shields.io provides badges that are often used here on GitHub. You can provide content using a json endpoint at the SKOS testing tool that returns data in a json schema; see https://shields.io/endpoint for examples and details.

That's a good point about what is a pass / fail varies by system. I think it would be helpful to focus on checking that files conform to the schema and can be interpreted, and then identify problems with the content on top. A file that cannot be interpreted at all should be a fail, and problems with content could be seen as sort-of-passing.

Challenges related to which system accepts what content should be dealt with by that system (i.e. out of scope).

For example, an skos validating testing tool could generate something like this if the translations were missing...

{
  "schemaVersion": 1,
  "label": "skos validator",
  "message": "missing translations",
  "color": "orange"
}

and if the validator detects no file-related problems, then...

{
  "schemaVersion": 1,
  "label": "skos validator",
  "message": "file passes",
  "color": "green"
}

@tfrancart
Copy link
Collaborator

tfrancart commented Oct 22, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants