Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [egit-dev] Contributions to EASE

Great to see that you push this topic further, Max.
I had a short look at the provided commit. The main question here is whether you want to keep EASE code in separate plugins or if you even want to push it to some already existing egit bundles. EASE introduces a build time dependency to org.eclipse.ease (to get the annotations from), nothing more. The extension point will not harm anybody if EASE is not installed and the module classes could be kept private API as they do not need to get exported for EASE to be consumed. Then you would not have to worry about internal API usage.

The only thing to consider is to keep the scripting interface stable. So design your API in a way that you do not need to rename/remove methods or that you have to exchange parameters. Adding new methods and parameters (and mark them optional) is ok. @since tags would be appreciated, however we do not parse them at the moment. However there are plans to make them visible in documentation in later releases. @deprecated tags will already be considered. But as is is hard to check scripts for API dependencies I would try to not deprecate script API if possible.

Christian


On 22.01.2017 13:33, Max wrote:
Hi everybody,

Thanks Christian for introducing the EGit EASE modules!

I'd vote for moving the modules over to the EGit repository for the same reasons. It seems nobody here objects to this, so I created Bug 510827 [1] and an inital patch-set [2].

The change is actually quite small, and mostly consists of boilerplate that is necessary because we probably want to keep this an optional feature. The code is only a thin wrapper for the EGit API. As long as it stays this way, I have no problem taking care of any maintenance that might be needed. If you want to learn more about EASE, check out the slides and examples from this talk:
https://www.eclipsecon.org/europe2016/session/elevate-your-ide-scripts

Cheers
Max

[1] https://bugs.eclipse.org/bugs/show_bug.cgi?id=510827
[2] https://git.eclipse.org/r/#/c/89293/



Back to the top