summaryrefslogtreecommitdiff
path: root/api_changes.md
diff options
context:
space:
mode:
authorRohit Jnagal <jnagal@google.com>2015-03-25 17:54:23 +0000
committerRohit Jnagal <jnagal@google.com>2015-03-25 18:00:52 +0000
commit4d946b3353672a2b27cde2aed92b0ab7abbd7c10 (patch)
treebe48914038b192964292f3057127a087e4259ea0 /api_changes.md
parentcd5cc3bdf65d167d9bfc932619fda47744d12933 (diff)
Add a pointer to kubernetes-dev to API changes doc.
Diffstat (limited to 'api_changes.md')
-rw-r--r--api_changes.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/api_changes.md b/api_changes.md
index c1005278..be02e16c 100644
--- a/api_changes.md
+++ b/api_changes.md
@@ -284,6 +284,12 @@ you'll figure it out. Put `grep` or `ack` to good use.
If you added functionality, you should consider documenting it and/or writing
an example to illustrate your change.
+## Incompatible API changes
+If your change is going to be backward incompatible or might be a breaking change for API
+consumers, please send an announcement to `kubernetes-dev@googlegroups.com` before
+the change gets in. If you are unsure, ask. Also make sure that the change gets documented in
+`CHANGELOG.md` for the next release.
+
## Adding new REST objects
TODO(smarterclayton): write this.