Skip to content

Commit

Permalink
Updating deprecation policy - closes #367
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Davies committed Feb 7, 2017
1 parent 9c1a247 commit 47edbc8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
12 changes: 12 additions & 0 deletions standard/docs/en/schema/deprecation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Deprecation

From time to time fields and codelist values may be removed from the Open Contracting Data Standard.

This will be either due to limited use, or because they have been replaced by alternative fields or codelists.

Before a field or codelist value is removed, it will be first marked as deprecated in a major or minor release (e.g. in 1.1), and removal will only take place, subject to the [governance](governance.md) process, in the next major version (e.g. 2.0).





1 change: 1 addition & 0 deletions standard/docs/en/schema/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The [release schema reference](reference.md) page provides guidance on using eac
identifiers
codelists
conformance_and_extensions
deprecation
changelog
```
2 changes: 1 addition & 1 deletion standard/docs/en/support/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Following **working group** approval, the revision branch can be set to live.

See https://github.com/open-contracting/standard/issues/189

If a term (a class or property) is scheduled to be renamed or removed from the specification as a result of the revision process, the next major release of the specification must [deprecate](https://en.wikipedia.org/wiki/Deprecation) the term within the schema, and the following major release must rename or remove the term from the schema, making the term obsolete. Implementations may use deprecated terms, but will receive warnings from the OCDS validator described below. Implementations may not use obsolete terms, and will receive errors from the OCDS validator.
If a term (a class or property) is scheduled to be renamed or removed from the specification as a result of the revision process, the next minor release of the specification must [deprecate](https://en.wikipedia.org/wiki/Deprecation) the term within the schema, and the following major release must rename or remove the term from the schema, making the term obsolete. Implementations may use deprecated terms, but will receive warnings from the OCDS validator described below. Implementations may not use obsolete terms, and will receive errors from the OCDS validator.

## Support policy

Expand Down

0 comments on commit 47edbc8

Please sign in to comment.