fossabot/standards-1

Provides the standards for LifeEngine APIs. https://digitalliving.github.io/standards/v1/

Digital Living Standards repository

This repository contains everything we need to standardize the Digital Living LifeEngine APIs.

The Digital Living core ontology can be found as a JSON-LD ontology file under Ontology/dli.jsonld.

The HTML version of the ontology documentation is hosted at our Github Pages

Please note that this repository is under active development, and the IRIs and URIs in the ontology files are subject to change at any time.

Contribution guidelines

We accept contributions to this repository via Pull Requests. You can fork the repository, make your suggested changes in there, and then submit a Pull Request via GitHub.

Before you submit a PR, please check that you follow these guidelines though to avoid unnecessary work from everyone:

1. Install pre-commit and make it active in your local clone (pre-commit install in repo root). Ensure this is in place BEFORE you make any changes, or later run pre-commit run --all-files.
2. Ensure your committed code follows the style guide configured in the repository (handled automatically by pre-commit)
3. Check that your naming follows existing standards. E.g. for JSON keys in Data Product we use camelCase always, do not try to submit new standards using snake_case.
4. Ensure you're submitting new things, i.e. check if there is an existing Data Product that already fits the use-case.
5. Breaking changes should be introduced via draft. If you want to add anything new, or propose a change to an existing standard that could break backwards compatibility, you should submit the changes in the draft version. Afterwards we can figure out which release version they can go in.

License