Skip to content

Latest commit

 

History

History
43 lines (23 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

43 lines (23 loc) · 2.42 KB
Raw

How to Contribute

We welcome community contributions, whether they are documentations, refactoring, tests, or new features.

You can contribute to PyGraft in the following ways:

  • File a bug report

  • File a feature request

  • Help other users by commenting on pending issues

  • Help implementing unit tests

  • Help refactoring code and ensuring best practices are respected

  • Generate clean docstrings for the existing code base

  • Implement a new feature (see Desirable Features)

Important

PyGraft is a nascent project. It still lacks unit tests and a clear choice of code formatting and documentation standards. We plan on using black as code formatter and the Google Python guidelines for the documentation. We welwome any open discussion on this topic. Later on, this section will be modified to reflect our strict commitment to our chosen code formatting and documentation standards.

Desirable Features

Additional features will be provided in the next versions of PyGraft. You want to contribute but do not know how? Here are a few desirable features to implement to get you up and running:

High Priority

  • Allow support for any input schema (and not only the schemas generated by PyGraft).
  • Allow explanations for inconsistencies to be parsed from HermiT API. This would make it possible to remove a subset of triples from inconsistent KGs to make them consistent, without needing the user to run the KG generation pipeline again. This is especially true for very large graphs, or if the user comes with an already existing schema which is not perfectly consistent.

Medium Priority

  • Fix the conflict between the following properties rdfs:subPropertyOf, owl:FunctionalProperty, and owl:InverseFunctionalProperty, as a non-zero value for the three of them at the same time can lead to inconsistent KGs.

Low Priority

  • Facilitate the generation of larger KGs (this would imply removing any dependency to rdflib).
  • Add support for literals.