document changes and how to contribute

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## [0.1.1] - 2023-07-05
+
+### Added
+
+- Add recommended property `method_type` with controlled vocabulary
+- Document how to run examples data with ([`examples/README.md`](examples/README.md))
+- Add a [`CHANGELOG.md`](CHANGELOG.md) ([Common Changelog](https://common-changelog.org))
+
+### Changed
+
+- Bump LinkML from `1.5.5` to `1.5.6`
+- Document how to contribute [`CONTRIBUTING.md`](CONTRIBUTING.md)
+
+## [0.1.0] - 2023-06-23
+
+:seedling: Initial release.
+
+
+[0.1.1]: https://fair-mi.github.io/miiid-schema/releases/tag/v0.1.1
+
+[0.1.0]: https://fair-mi.github.io/miiid-schema/releases/tag/v0.1.0

CONTRIBUTING.md

@@ -34,19 +34,19 @@ Please carefully read our [Code of Conduct](CODE_OF_CONDUCT.md).
 
 ### Reporting problems with the data model
 
-Please use our [Issue Tracker][issues] to report problems with the ontology.
+Please use our [Issue Tracker][issues] to report problems with the LinkML metadata schema
 
 <a id="requesting-terms"></a>
 
-### Requesting new terms
+### Requesting new properties
 
-Please use our [Issue Tracker][issues] to request a new term for the ontology.
+Please use our [Issue Tracker][issues] to request a new property for the schema.
 
 <a id="adding-terms"></a>
 
-### Adding new terms yourself
+### Adding new properties yourself
 
-Please submit a [Pull Request][pulls] to submit a new term for consideration.
+Please submit a [Pull Request][pulls] to submit a new property for consideration.
 
 <a id="best-practices"></a>
 

README.md

@@ -20,8 +20,12 @@ Towards a Minimal Information about Intermicrobial Interaction Data schema
       Python datamodel
 * [tests/](tests/) - Python tests
 
+> Be sure to have a look at the [`CHANGELOG.md`](CHANGELOG.md) to know about the changes in the schema!
+
 ## Developer Documentation
 
+Interested in contributing to `miiid-schema`? Thanks, please make sure to read through [`CONTRIBUTING.md`](CONTRIBUTING.md) first.
+
 <details>
 Use the `make` command to generate project artefacts: