[IMPORTANT] - Changing API - Must document changes in release notes
Hi The API in camel-core have changed on trunk recently by the works of Christian S. I just to remind that its important to notice all the API breaking changes in the API section in the release notes. I have noticed that the release notes hasn't been updated accordingly to changes. I suggest to update the release notes at the time when you commit changes, as then you wont forget. What we need to put in there, is for example when a class has been *moved* to a new package, which mean there is not even an old @deprecated class. We ought also to mention important classe which may have been @deprecated in favor of some other class etc. Our user base should have this information up-front so they can take that into account, in their migration plans. -- Claus Ibsen - FuseSource Email: cib...@fusesource.com Web: http://fusesource.com Twitter: davsclaus, fusenews Blog: http://davsclaus.blogspot.com/ Author of Camel in Action: http://www.manning.com/ibsen/
Re: [IMPORTANT] - Changing API - Must document changes in release notes
Hi Claus, thanks for reminding. Documenting the changes make a lot of sense of course. Christian Am 31.08.2011 08:48, schrieb Claus Ibsen: Hi The API in camel-core have changed on trunk recently by the works of Christian S. I just to remind that its important to notice all the API breaking changes in the API section in the release notes. I have noticed that the release notes hasn't been updated accordingly to changes. I suggest to update the release notes at the time when you commit changes, as then you wont forget. What we need to put in there, is for example when a class has been *moved* to a new package, which mean there is not even an old @deprecated class. We ought also to mention important classe which may have been @deprecated in favor of some other class etc. Our user base should have this information up-front so they can take that into account, in their migration plans. -- Christian Schneider http://www.liquid-reality.de Open Source Architect http://www.talend.com
Re: [IMPORTANT] - Changing API - Must document changes in release notes
Documented the potentially incompatible changes in the release notes. Christian Am 31.08.2011 08:48, schrieb Claus Ibsen: Hi The API in camel-core have changed on trunk recently by the works of Christian S. I just to remind that its important to notice all the API breaking changes in the API section in the release notes. I have noticed that the release notes hasn't been updated accordingly to changes. I suggest to update the release notes at the time when you commit changes, as then you wont forget. What we need to put in there, is for example when a class has been *moved* to a new package, which mean there is not even an old @deprecated class. We ought also to mention important classe which may have been @deprecated in favor of some other class etc. Our user base should have this information up-front so they can take that into account, in their migration plans. -- -- Christian Schneider http://www.liquid-reality.de Open Source Architect Talend Application Integration Division http://www.talend.com
