Skip to content

Naming convention: Policy / Policy Item? #37

@zyzzyxdonta

Description

@zyzzyxdonta

Since documents that describe all the rules are usually called "policy", I think we should make the distinction between "policy" and "policy item". A policy would be comprised of one or more policy items. E.g.:

  • Policy: HZDR Software Policy
  • Policy Item: Only Apache 2.0 license may be used

This means a policy would likely be a file like this (i.e. an owl:Ontology, because that's how the import mechanism works in SHACL):

@prefix owl: <http://www.w3.org/2002/07/owl#> .

<> a owl:Ontology .
<> owl:imports <../policy-items/license.ttl> .

Whereas a policy item would look like this (one or more SHACL things such as shapes, constraint components, ...):

@prefix codemeta: <https://doi.org/10.5063/schema/codemeta-2.0#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

scex:licenseRequirements a sh:NodeShape ;
    sh:targetClass schema:SoftwareSourceCode ;

    sh:property [
        sh:name "Apache-2.0 license" ;
        sh:description "Apache-2.0 license must be used" ;

        sh:path schema:license ;
        sh:datatype xsd:string ;
        sh:hasValue "https://spdx.org/licenses/Apache-2.0" ;
    ] ;

    .

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions