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

Create automatic verifications and improvements #204

Open
pedropaulofb opened this issue May 24, 2022 · 2 comments
Open

Create automatic verifications and improvements #204

pedropaulofb opened this issue May 24, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@pedropaulofb
Copy link
Member

pedropaulofb commented May 24, 2022

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 pedropaulofb added the enhancement New feature or request label May 24, 2022
@pedropaulofb pedropaulofb self-assigned this May 24, 2022
@pedropaulofb pedropaulofb changed the title Create automatic verifications Create automatic verifications and improvements May 27, 2022
@pedropaulofb
Copy link
Member Author

When created, the mandatory execution of this tool must be registered on the admins' instructions page (see issue #216).

@pedropaulofb
Copy link
Member Author

I created the repository ontouml-models-tools for implementing all the necessary features here listed. As soon as its first version is released, I'll close this issue, as all necessary features are there reported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant