RDF elements descriptions

Open
#110 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Locate the ontology file and inspect its header and element declarations. Add the SKOS namespace, ensure each element has an rdfs:label and skos:definition, and replace rdfs:comment where appropriate. Done means definitions follow the stated ISO 704 style, with additional details moved to suitable annotations such as skos:note.

Written by the indexing model from the issue text.

Description

Feedback from OMG:

  1. Every element in your ontology should be declared and have, at a minimum, an rdfs:label and skos:definition. That would require adding the namespace for SKOS (Simple Knowledge Organization System, which is a W3C recommendation) to the header of your file, and then using skos:definition throughout rather than rdfs:comment. Definitions should be expressed using ISO 704 style, which is an expression that does not start with an upper case letter (unless the word is a proper noun), does not end in punctuation, and is not a full sentence. It should be something you can use to replace the name of the concept/class in a sentence. Any other details should be in skos:note, or similar annotation. We define a number of useful annotations in the Commons Annotation Vocabulary at the URI given in 4. You might consider importing it if any of them are useful to you. Certainly for the copyright statement you should consider doing so.
Dominant language
Python
Stars
11
Forks
13
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from spdx/spec-parser

All issues in spdx/spec-parser

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.