{"action":"created","issue":{"url":"https://api.github.com/repos/openlayers/ol3-cesium/issues/149","labels_url":"https://api.github.com/repos/openlayers/ol3-cesium/issues/149/labels{/name}","comments_url":"https://api.github.com/repos/openlayers/ol3-cesium/issues/149/comments","events_url":"https://api.github.com/repos/openlayers/ol3-cesium/issues/149/events","html_url":"https://github.com/openlayers/ol3-cesium/issues/149","id":53853337,"number":149,"title":"How to handle breaking API changes","user":{"login":"ahocevar","id":211514,"avatar_url":"https://avatars.githubusercontent.com/u/211514?v=3","gravatar_id":"","url":"https://api.github.com/users/ahocevar","html_url":"https://github.com/ahocevar","followers_url":"https://api.github.com/users/ahocevar/followers","following_url":"https://api.github.com/users/ahocevar/following{/other_user}","gists_url":"https://api.github.com/users/ahocevar/gists{/gist_id}","starred_url":"https://api.github.com/users/ahocevar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ahocevar/subscriptions","organizations_url":"https://api.github.com/users/ahocevar/orgs","repos_url":"https://api.github.com/users/ahocevar/repos","events_url":"https://api.github.com/users/ahocevar/events{/privacy}","received_events_url":"https://api.github.com/users/ahocevar/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":13,"created_at":"2015-01-09T10:24:00Z","updated_at":"2015-01-12T11:06:26Z","closed_at":null,"body":"With #147, a second signature for the `olcs.OLCesium` constructor was introduced. @gberaudo suggested to mark the old signature with a `@deprecated` annotation and a console message that reminds developers to change their code to use the new signature.\r\n\r\nThis ticket is about deciding how we handle breaking API changes. My suggestion was to use [Semantic Versioning](http://semver.org/). @tschaub suggested that we could also use [Sentimental Versioning](http://sentimentalversioning.org) instead. That would let us pick our favorite version numbers and break things without feeling bad. What @gberaudo suggests (add a deprecation warning and break things two point releases after the warning was added) would fall into that category.\r\n\r\nWhat do others think?"},"comment":{"url":"https://api.github.com/repos/openlayers/ol3-cesium/issues/comments/69555279","html_url":"https://github.com/openlayers/ol3-cesium/issues/149#issuecomment-69555279","issue_url":"https://api.github.com/repos/openlayers/ol3-cesium/issues/149","id":69555279,"user":{"login":"gberaudo","id":7294662,"avatar_url":"https://avatars.githubusercontent.com/u/7294662?v=3","gravatar_id":"","url":"https://api.github.com/users/gberaudo","html_url":"https://github.com/gberaudo","followers_url":"https://api.github.com/users/gberaudo/followers","following_url":"https://api.github.com/users/gberaudo/following{/other_user}","gists_url":"https://api.github.com/users/gberaudo/gists{/gist_id}","starred_url":"https://api.github.com/users/gberaudo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gberaudo/subscriptions","organizations_url":"https://api.github.com/users/gberaudo/orgs","repos_url":"https://api.github.com/users/gberaudo/repos","events_url":"https://api.github.com/users/gberaudo/events{/privacy}","received_events_url":"https://api.github.com/users/gberaudo/received_events","type":"User","site_admin":false},"created_at":"2015-01-12T11:06:26Z","updated_at":"2015-01-12T11:06:26Z","body":"Each month we will move forward, bringing in the latest stable Ol3 and\nCesium. As a consequence, we will never publish an `only bugfixes' release.\n\nSecond point, the project is in a phase where breaking changes may likely\nhappen. Increasing the major version number would not give more\ninformation to the user.\n\nIt seems wiser to keep the major versions for an important change /\nmilestone of the project. For example, when we will change the\n`breaking changes` policy.\n\n\nI would be interested to hear more opinions and feedbacks about this."}}