diff --git a/docs/fdc3-compliance.md b/docs/fdc3-compliance.md index 9eacc7f70..5aa96b1c9 100644 --- a/docs/fdc3-compliance.md +++ b/docs/fdc3-compliance.md @@ -57,7 +57,7 @@ FDC3 adopts the following deprecation policy: 1. A feature can be deprecated by any major or minor version. Newly deprecated features will be described in the [Changelog](https://github.com/finos/FDC3/blob/master/CHANGELOG.md). 2. A feature shall only be removed by a major version. Newly removed features will be described in the [Changelog](https://github.com/finos/FDC3/blob/master/CHANGELOG.md). -3. Deprecated features are clearly marked with an `@deprecated` tag and comment in both the documentation and jsDocs applied to the Typescript sources. +3. Deprecated features are clearly marked with an `@deprecated` tag and comment in both the documentation and jsDocs applied to the TypeScript sources. 4. Where possible, changes to the behavior of an existing feature should be avoided; consider deprecating it and replacing it with something with a different name/syntax. 5. Breaking change should only be made in a major version of the Standard. @@ -72,3 +72,4 @@ FDC3 adopts the following experimental features policy: 4. Unless otherwise stated, experimental features should be considered optional for compliance purposes, but recommended for implementation (i.e. the SHOULD keyword is implied). 5. Experimental features are exempted from the normal versioning and deprecation policies that govern changes to FDC3. I.e. breaking changes may be made to experimental features between versions of the Standard without a major version release. 6. The experimental designation maybe removed from a feature in a minor version release (as this will be considered an additive change). + diff --git a/website/README.md b/website/README.md index 8ed11e93f..0ecf96b76 100644 --- a/website/README.md +++ b/website/README.md @@ -62,7 +62,7 @@ Since FDC3 is a schema project, we don't follow semver, which is meant for libra ## Create a new version -Before creating a version, please make sure docs/fdc3-intro.md has been updated such the version number in the title and versioning section are correct for the version you are creating, as these have to be manually set. +Before creating a version, please make sure docs/fdc3-intro.md has been updated such that the version number in the title and versioning section are correct for the version you are creating, as these have to be manually set. Since the website also uses some generated and copied static files (like schemas), extra tasks need to be performed as part of creating a new version.