Browse Source

Merge "Add upgrades and backwards compatibility section"

Jenkins 2 years ago
parent
commit
685a9d05bc
1 changed files with 22 additions and 0 deletions
  1. 22
    0
      template.rst

+ 22
- 0
template.rst View File

@@ -218,6 +218,28 @@ such as:
218 218
   other hooks would implement the feature is required. Describe how
219 219
   existing hooks will continue to function after the change.
220 220
 
221
+Upgrades and Backwards Compatibility
222
+------------------------------------
223
+
224
+Care must be taken to support our users by not breaking backwards compatibility
225
+with either REST API or plugins API for data processing.
226
+
227
+* If your proposal includes any changes to the REST API, describe how existing
228
+  clients will continue to function when interacting with an upgraded API
229
+  server.
230
+
231
+* If your proposal includes any changes to the plugins API, describe how
232
+  existing plugins implementations will continue to function with the new
233
+  plugin interface.
234
+
235
+* Describe what testing you will be adding to ensure that backwards
236
+  compatibility is maintained.
237
+
238
+* If deprecating an existing feature or API, describe the deprecation plan, and
239
+  for how long compatibility will be maintained.
240
+
241
+* If new code should need something more than 'db migrations', describe
242
+  upgrading procedure here.
221 243
 
222 244
 Implementation
223 245
 ==============

Loading…
Cancel
Save