Add CHANGELOG containing release notes (#375)

* Added a CHANGELOG containing release notes * Add link to CHANGELOG in README * Formatting * Add clarifying word * Apply suggestions from code review Co-authored-by: Rickard Armiento <[email protected]> * Placate pre-commit Co-authored-by: Rickard Armiento <[email protected]>
Materials-Consortia · Jul 8, 2021 · 6f1e115 · 6f1e115
1 parent 1df939b
commit 6f1e115
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,25 @@
+# Changelog
+
+## v1.1.0 (July 8, 2021)
+
+This is release v1.1.0 of the OPTIMADE API specification.
+
+This is a minor release that primarily patches minor specification errors and introduces one new feature.
+
+### New features
+
+- The `implementation` field of the general `meta` response has been updated to include an `issue_tracker` field ([#339](https://github.com/Materials-Consortia/OPTIMADE/pull/339)).
+
+### Patches
+
+- The `mass` field of the `species` attribute for the `structures` entry type has been updated from a float to a list of floats ([#344](https://github.com/Materials-Consortia/OPTIMADE/pull/344)).
+    - This was deemed a specification bug that now is fixed in both the specification text and the schemas.
+    - Note: this could constitute a breaking change for software implemented to strictly adhere to the v1.0.0 specification.
+- The specification text has been clarified in several places without change of intended meaning.
+- Multiple typos, grammatical errors, and incorrect API examples have been fixed.
+- The OpenAPI schemas are now fully compliant with the Swagger validator.
+
+
+## v1.0.0 (July 1, 2020)
+
+This is release v1.0.0 of the OPTIMADE API specification.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ This repository contains the specification of the OPTIMADE API.
 
 * [optimade.rst](optimade.rst): The API specification.
 * [AUTHORS](AUTHORS): List of contributors.
+* [CHANGELOG](CHANGELOG.md): The release notes for each version of the specification.
 * [optimade.org](https://www.optimade.org): Public OPTIMADE web site
 * [OPTIMADE wiki](https://github.com/Materials-Consortia/OPTIMADE/wiki): Information for developers