ontouml-models icon indicating copy to clipboard operation
ontouml-models copied to clipboard

Create automatic verifications and improvements

Open pedropaulofb opened this issue 2 years ago • 2 comments

Verifications for metadata.yaml

General

  • Validate syntax
  • Validate fields type (string, int, etc.)
  • Validate fields structure (e.g., some fields are lists and some are not)
  • Verify if mandatory fields are filled

title field

  • Must be title case

issued and modified fields

  • Modified value must be greater than the issued value

contributor field

  • One entry per author
  • The number of authors must match the number of entries
  • No duplications (inside a single metadata file or among all available in the repository)

source field

  • One source per BibTeX entry of references.bib file
  • No duplications

Verifications for references.bib

General

  • Validate syntax
  • Apply bibtex-tidy
  • Check if the number of references in the references.bib file is exactly the same number of entries in the metadata.yaml's source field. The values must always match.

Verifications for images

  • The name for the same diagram in the original and new diagrams folder must match.

Verifications for all files

  • The files' names must contain only valid characters for Windows and Linux directory paths. The Visual Paradigm allows the creation of diagrams with invalid characters, like ":" - in this case, the generated image is going to have an invalid path name. The substitution has impact on the VPP, JSON, PNGs and TTL files (specific and general for this last one).
  • Verify for duplicated ontology names and acronyms as a way of reducing possible duplicates.

pedropaulofb avatar May 24 '22 12:05 pedropaulofb