Skip to content

further validation of instances on PR/commit #250

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

Open
lzehl opened this issue Jan 30, 2025 · 2 comments
Open

further validation of instances on PR/commit #250

lzehl opened this issue Jan 30, 2025 · 2 comments
Assignees
Labels
docu improvements or additions to documentation technical anything related to the repository

Comments

@lzehl
Copy link
Member

lzehl commented Jan 30, 2025

Things to check:

  • namespace convention for type, atid, props
  • instance located in wrong subfolder (e.g. ProgrammingLanguage instance in AnalysisTechnique folder)
  • mismatch between attype and atid (e.g. type:...ProgrammingLanguage, atid:...instances/analysisTechnique/xxx.jsonld)
  • alphabetically ordering of properties (convention check, maybe should just be done for you)
  • convention check for name vs atid vs filename (for terminologies, licenses, contentType)
    • atid_basename == lower camelCase of name (no spaces, / replaced with _; proper names and abbreviations are to be kept)
    • filename == atid_basename with .jsonld extension (no spaces, / replaced with _)
  • general validation against schema
@lzehl
Copy link
Member Author

lzehl commented Jan 30, 2025

should also be covered in contribution guidelines on docu

@Raphael-Gazzotti
Copy link
Member

The validation pipeline has been updated, although the documentation still requires updating.

@Raphael-Gazzotti Raphael-Gazzotti added the docu improvements or additions to documentation label Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docu improvements or additions to documentation technical anything related to the repository
Projects
None yet
Development

No branches or pull requests

2 participants