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

Implement a "file system" harvester #271

Open
led02 opened this issue Aug 27, 2024 · 1 comment
Open

Implement a "file system" harvester #271

led02 opened this issue Aug 27, 2024 · 1 comment
Labels
1️ harvesting The harvesting step in the workflow good first issue Good for newcomers 📊 Software CaRD Related to the Software CaRD project

Comments

@led02
Copy link
Member

led02 commented Aug 27, 2024

While evaluating the Helmholtz KPIs, I stubled across different "metrics" that ... kind of rely on certain ... "files" (or artifacts) being present (e.g., "Some kind of description is available giving further information on the software in this repository (e.g. readme file).").

This could be evaluated using graph constraints if there was an entry for this in the graph. Hence, my approach would be to create a "file system" harvester that collects (relevant) files from the repository.

Not being a metadata expert, I would use the "hasPart" attribute to store such information, i.e.,

  ...
  "hasPart": [
    {
      "@type": "CreativeWork",
      "name": "README",
      "encoding": {
        "@type": " TextObject",
        "encodingFormat": "text/markdown",
        "url": "file://./README.md"
      }
    },
    ...
  ]
@led02 led02 added good first issue Good for newcomers 1️ harvesting The harvesting step in the workflow 📊 Software CaRD Related to the Software CaRD project labels Aug 27, 2024
@led02
Copy link
Member Author

led02 commented Aug 28, 2024

CodeMeta defines an explicit "readme" term. Yet, the file system harvester might also capture other ... "parts"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1️ harvesting The harvesting step in the workflow good first issue Good for newcomers 📊 Software CaRD Related to the Software CaRD project
Projects
None yet
Development

No branches or pull requests

1 participant