Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs(schema): add deprecation policy #261

Merged
merged 5 commits into from
Nov 4, 2020
Merged

docs(schema): add deprecation policy #261

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f12b73d
docs(schema): add deprecation policy
markborkum Oct 21, 2020
787cb9a
fix typos
markborkum Oct 21, 2020
f884043
docs(schema): add note to developer resources
markborkum Oct 26, 2020
19e6d3a
Merge branch 'develop' into docs/deprecation-policy
corymosiman12 Oct 28, 2020
99d6fd8
Merge branch 'develop' into docs/deprecation-policy
nllong Nov 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions BuildingSync.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
<xs:import namespace="http://www.gbxml.org/schema" schemaLocation="http://www.gbxml.org/schema/6-01/GreenBuildingXML_Ver6.01.xsd"/>
<xs:annotation>
<xs:documentation>BuildingSync Schema - Version 2.2.0</xs:documentation>
<xs:documentation xmlns="http://www.w3.org/1999/xhtml">
<h1>BuildingSync Schema Deprecation Policy</h1>
<p>This document details the deprecation policy for the BuildingSync Schema.</p>
<h2>Deprecating schema elements</h2>
<p>Since the development of the BuildingSync Schema is application-driven, the schema document itself has evolved over time to reflect the evolving understanding of the problem space.</p>
<p><b>Rule #1: Schema elements may only be removed by incrementing the major version of the schema document.</b></p>
<p>Once a schema element has been added to the schema document at a particular version, it cannot be removed from that version or have its behavior significantly changed, regardless of track.</p>
</xs:documentation>
</xs:annotation>
<xs:element name="BuildingSync">
<xs:complexType>
Expand Down