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

URNs, Links, Templates, Schema, Defaults #3

Merged
merged 15 commits into from
May 30, 2024
Merged

Conversation

anneschuth
Copy link
Member

@anneschuth anneschuth commented May 29, 2024

In this PR I introduce a few changes to the instrument registry format by changing the example iama.yaml.

  • Move to urns (instead of IDs)
  • Move to links being lists of objects (instead of strings)
  • Move to system card templates to make it clear why answers even appear
  • Use 'open_question' instead of 'open question' as a task type
  • Remove measures folder (leftover)
  • Formatted the yaml file
  • Introduced a proper schema and schema validation
  • Adds all defaults from MinBZK/python-project-template

@anneschuth anneschuth requested review from GuusjeJuijn and a team May 29, 2024 13:33
Copy link
Contributor

@GuusjeJuijn GuusjeJuijn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also adjust the json schema according to this new link structure?

Copy link
Contributor

@GuusjeJuijn GuusjeJuijn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 👍

@anneschuth anneschuth force-pushed the feature/urns-links branch from 3d6a46c to 938a45a Compare May 29, 2024 17:50
@anneschuth
Copy link
Member Author

@GuusjeJuijn I've added a proper schema and schema validation as well

@anneschuth anneschuth changed the title URNs, Links, Templates URNs, Links, Templates, Schema May 29, 2024
@anneschuth anneschuth force-pushed the feature/urns-links branch from 3e9a6ed to 07e605c Compare May 29, 2024 18:56
@anneschuth anneschuth requested a review from GuusjeJuijn May 29, 2024 19:16
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@anneschuth anneschuth requested a review from a team May 29, 2024 19:27
@anneschuth anneschuth changed the title URNs, Links, Templates, Schema URNs, Links, Templates, Schema, Defaults May 29, 2024
schema.json Show resolved Hide resolved
Copy link
Contributor

@ChristopherSpelt ChristopherSpelt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one small comment, but looks very good!

instruments/iama.yaml Outdated Show resolved Hide resolved
@anneschuth anneschuth merged commit 776d8ab into main May 30, 2024
5 checks passed
@anneschuth anneschuth deleted the feature/urns-links branch May 30, 2024 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants