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

Add implementation metadata. #25

Open
davidlehn opened this issue Aug 30, 2022 · 0 comments
Open

Add implementation metadata. #25

davidlehn opened this issue Aug 30, 2022 · 0 comments

Comments

@davidlehn
Copy link

The generated test suite output table just has a text field for the columns. Readers need more data on what this text refers to. Right now it's displaying the name field, and the implementation field is not used? I'd suggest adding more optional metadata in the implementation JSON files. It might make more sense for the test result table columns to use the implementation text field instead. Then have another table that maps that implementation name to the implementer name, with optional link to their URL, the implementation, with optional link to its URL, an optional implementation version/date if appropriate, and maybe optional implementation notes. Most details should be left to implementers to put on their own sites, but at least need links to those sites. All this would greatly help readers to know what is being tested and where to find more info.

While maybe this should be using EARL and DOAP for properties, a quick freeform schema could be:

  • implementation: name of the implementation
  • [implementationUrl]: optional URL for implementation
  • implementer: name of implementer (company, organization, person, etc)
  • [implementerUrl]: optional URL for implementer
  • [version]: optional implementation version (this may be difficult if using live services)
  • [date]: optional implementation date (this may be difficult if using live services)
  • [notes]: optional notes (anything brief for a table, but leave most details at the implementation URLs)
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

1 participant