add more procedural knowledge into the contributing guide #92

Merged
adina merged 1 commit from contribute into main 2025-09-23 08:20:12 +00:00

View file

@ -65,6 +65,20 @@ hatch shell
make checkmodel/flat-data/unreleased
```
### Switching import locations
Although most rules will perform this action automatically, the following command allows to switch from a remote-URL import to an import from a local file (which is relevant when, for example, there is no remote URL yet to import from, or you are testing local changes):
```
make imports-local
```
Its opposite command, reverting imports back to remote URLs, is
```
make imports-remote
```
### Example conversion
Each schema has example data used for testing.
@ -110,3 +124,9 @@ linkml convert -o ds.ttl -s src/flat-data/unreleased.yaml --target-class-from-pa
* Because LinkML allows imports from other schemas, there may be more to the classes or slots you see defined in any given file.
In order to figure out easily which slots are available or even required, we recommend that you **render the documentation locally**, as this allows you to browse through the classes and discover also information that comes from other schemas.
* A broad swipe of checks for any new or existing component can be achieved with the following command composition (where one replaces ``component`` with the schema name):
```
export component=flat-data; make checkmodel/$component/unreleased convertexamples/$component/unreleased checkvalidation/$component/unreleased
```