Add upgrades and backwards compatibility section
Change-Id: I8fb93681a7538773647d2a982acde90c387f0e2f
This commit is contained in:
parent
a68360f960
commit
1524f01574
22
template.rst
22
template.rst
|
@ -218,6 +218,28 @@ such as:
|
|||
other hooks would implement the feature is required. Describe how
|
||||
existing hooks will continue to function after the change.
|
||||
|
||||
Upgrades and Backwards Compatibility
|
||||
------------------------------------
|
||||
|
||||
Care must be taken to support our users by not breaking backwards compatibility
|
||||
with either REST API or plugins API for data processing.
|
||||
|
||||
* If your proposal includes any changes to the REST API, describe how existing
|
||||
clients will continue to function when interacting with an upgraded API
|
||||
server.
|
||||
|
||||
* If your proposal includes any changes to the plugins API, describe how
|
||||
existing plugins implementations will continue to function with the new
|
||||
plugin interface.
|
||||
|
||||
* Describe what testing you will be adding to ensure that backwards
|
||||
compatibility is maintained.
|
||||
|
||||
* If deprecating an existing feature or API, describe the deprecation plan, and
|
||||
for how long compatibility will be maintained.
|
||||
|
||||
* If new code should need something more than 'db migrations', describe
|
||||
upgrading procedure here.
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
|
Loading…
Reference in New Issue