From b68b2bef496e40ec42f34dd16f4d2b83420eb317 Mon Sep 17 00:00:00 2001 From: Dorota Jarecka Date: Thu, 20 Jun 2024 13:27:37 -0400 Subject: [PATCH] adding pre-commit to readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 6ac585714..d4ee7ccbc 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,21 @@ This repository contains: ## Developing ReproSchema +### Updating the schema + As of release 1.0.0, a linked data modeling language, [LinkML](https://linkml.io/linkml/), is used to create a [YAML file](linkml-schema/reproschema.yaml) with the schema. The [context file](contexts/reproschema) was automatically generated using LinkML, and then manually curated in order to support all the reproschema feature. +#### Style + +This repo uses pre-commit to check styling. +- Install pre-commit with pip: `pip install pre-commit` +- In order to use it with the repository, you have to run `run pre-commit install` in the root directory the first time you use it. + + ### Release Upon release, there are additional formats, `jsonsld`, `turtle`, `n-triples` and `pydantic` that are created using `LinkML` tools, `reproschema-py`,