Skip to content

Commit b2957d8

Browse files
authored
Merge pull request #150 from linkml/adding-docs-for-1065
Adding a contributor guide, also describe model sync process
2 parents f5a9176 + 81cce44 commit b2957d8

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to this repository
2+
3+
## Contributing to the metamodel
4+
5+
* [linkml_model/model/schema](linkml_model/model/schema)
6+
7+
## Contributing to the specification
8+
9+
The source lives in
10+
11+
* [linkml_model/model/docs/specification](linkml_model/model/docs/specification)
12+
13+
## Building the site
14+
15+
The site https://linkml.io/linkml-model/ is hosted on GitHub pages.
16+
17+
Note: unlike most LinkML schema sites, this one *does not* use the
18+
gh-pages branch. The docs are served directly from the root folder of
19+
the main branch.
20+
21+
The [docs](docs) folder houses the built schema index.
22+
23+
To build the docs:
24+
25+
```
26+
make gendoc
27+
```
28+
29+
This stages the documentation in target/docs
30+
31+
You can test this:
32+
33+
```
34+
make serve
35+
```
36+
37+
## Model versioning and releases
38+
39+
See the [metamodel docs](https://linkml.io/linkml/schemas/metamodel.html) for a
40+
description of the versioning scheme.
41+
42+
MINOR versions should be synchronized with all code frameworks such as linkml-runtime.
43+
44+
To sync the minor version with linkml-runtime, see:
45+
46+
- https://github.com/linkml/linkml-runtime/blob/main/Makefile
47+
- https://github.com/linkml/linkml/issues/1065

0 commit comments

Comments
 (0)