[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [ide-dev] Link from inside Eclipse IDE to how to contribute

Of course we all know that setting up an IDE that can actually be used to work on the source code for any particular project is generally much more involved than knowing the location of the git clone. If the user is to contribute to Gerrit, it must be the Gerrit URI that's used for cloning. If they're going to contribute via Gerrit, most projects would expect the user to run some tests. Most projects require specialized things in the target platform in order to compile all their projects, including their tests, and also to launch a self-hosted IDE where improved/fixed functionality can actually be tested.

Without an Oomph setup for the project(s) involved, it seems unlikely that all those things could be achieved. Also, many of the packages don't necessarily even have installed all the things needed to do general plug-in development for arbitrary projects. And, in the end, would users really want to do all this in the actual IDE that they're already using for some other purpose? I doubt that.

As such I'm very skeptical that this can be done or even should be done in the running IDE that the user is using for their own development activities. It would seem better to me to have a link to a wiki page that explains how to set up a proper full development environment like the one used by the project developers, ideally a very short page that describes an automated setup process. Or better yet a link to an Oomph Configuration https://wiki.eclipse.org/Eclipse_Oomph_Authoring#Automation_and_Specialization_with_Configurations the user can drag and drop onto the Installer to create their 'I want to contribute to Project X" development environment...

I'm also skeptical about who will actually do all the work to realize the good ideas in this thread...


On 29.09.2017 22:54, Andrey Loskutov wrote:
Hi Mickael,

See my answers inline.

On 29.09.2017 at 13:55 Mickael Istria wrote:

Targeting a product quality is a good goal, but it's also vital that end-users understand that the IDE depends on their contributions. We mustn't hide that, on the contrary, we must highlight it in the IDE.

Yes.

So I think we need a visible place inside the IDE to turn some users into contributors (report bug, contribute patches, donate money).

Yes.

I've thought about a few possibilities:
* Replace the Welcome page by the "How to contribute page".

No, but as already said, a prominent item in the welcome page would be great.


* An occasional -or on every startup- popup with a reminder and a link to the page

Not on every startup please. May be one time after first startup, like: "Did you know you can also contribute to Eclipse? ..."


* Occasionally -or on every startup- just showing up the webpage

Sounds like a bad spam.

* A link in the About dialog

Yes.

* A menu item in the Help menu

Yes.

I imagine those would make sense close to the USS plugin, and would make sense in EPP packages.

What do you think about trying something on that topic for Photon?

We should make sure the page looks good and is also really useful to allow potential contributors start immediately with hacking.


One item extra: let assume the error log view would have a popup "Fix this error", which would do following:

*If* this error is from one of the platform / org.eclipse plugin with "Eclipse-SourceReferences" entry in the manifest:

Try to import the platform plugin code from where the error is coming via git (like PDE wizard it does), automatically configure Gerrit, open the "how to contribute" page in the browser editor and open the file where the exception happened in the source editor?

The only few steps would be: create Eclipse account, sign ECA, change the code, commit and push.