Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Recommenders/ContributorGuide"

m (New page: = Development Environment = Building and testing Code Recommenders on your machine requires the following tools to be installed: # Eclipse 3.6 # Java 6 # Maven 3+ # Git 1.7+ = Obtaini...)
 
m (→‎Contributing Patches)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
= Development Environment =  
+
= Get in Contact  =
  
−
Building and testing Code Recommenders on your machine requires the following tools to be installed:
+
== Forum  ==
  
−
# Eclipse 3.6
+
Code Recommenders user forum is here: http://eclipse.org/forums/eclipse.recommenders. If you want to report an issue, request new features, or just get in contact with the development team, this is the preferred way.  
−
# Java 6
+
−
# Maven 3+
+
−
# Git 1.7+
+
  
 +
== Mailing List  ==
  
−
= Obtaining Sources =
+
Code Recommenders also maintains a developer mailing list. The recommenders-dev@eclipse.org list is used for announcements like committer election or notifying committers about build changes etc. Subscription is required to post messages to the list which can be done here: https://dev.eclipse.org/mailman/listinfo/recommenders-dev.
  
−
Code Recommenders is hosted in Git. To browse the repositories use [http://git.eclipse.org/c/recommenders/ Gitweb]. To checkout sources from command line use:
+
<br>  
−
<pre>
+
−
git clone git://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git recommenders
+
−
</pre>
+
  
 +
= Reporting Bugs  =
  
−
= Building From Sources =
+
Code Recommenders' Bugzilla is accessible via https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Recommenders
  
−
Code Recommenders uses Maven Tycho to build its plug-ins. Look out for the pom.xml files in the repositories. The typical command to build Code Recommenders from command line is:
+
<br>  
−
<pre>
+
−
mvn clean install
+
−
</pre>
+
−
That's it.
+
  
−
If this fails on your machine send a mail to the developer mailing list and report this issue.
+
= Contributing Patches  =
  
−
'''Note: Code Recommenders MUST be build once with Maven.'''<br>
+
We welcome patches. We develop software transparently using Eclipse [[Gerrit]]. If you want to contribute a patch.  simply submit it via Gerrit. If you have questions, how to set it up, check the [[Gerrit]] user guide or send an email to the recommenders-dev mailing list.
−
The recommender models are not hosted in the repository but on an external website. In order to run code completion, these models need to be downloaded once. This happens automatically during the first maven build.
+
  
−
= Compiling From Eclipse =
+
[[Category:Recommenders]]
−
 
+
−
After you have successfully (i) cloned the repository and (ii) run the first maven build, you are ready to import all required plug-ins, features, and update-sites from ${git-repository.basedir} into Eclipse. 
+
−
 
+
−
It's recommended to use a fresh Eclipse workspace since we work with ''target platforms'' to build Code Recommenders in Eclipse. If you are new to target platforms please check out [http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/concepts/target.htm this Eclipse Help page] for details.
+
−
 
+
−
After import you will see quite a lot compile errors due to missing 3rd-party plug-ins not available in your current Eclipse installation. To fix that you need to set the ''target platform'' of the workspace. This is done by simply:
+
−
 
+
−
# Opening the target platform definition file under ''/org.recommenders.releng/rcp-3.6.target''.
+
−
# Waiting until Eclipse resolved and downloaded all plug-ins (check the progress monitor). This may take a while for the first time.
+
−
# After resolving successfully finished, click on ''Set as Target Platform'' on the upper right corner of the editor.
+
−
# A workspace full build is now started by Eclipse. Wait until the build is finished. Hopefully all compile errors are gone now - except for org.eclipse.recommenders.*fixture* projects. They don't compile per construction.
+
−
# If not, refresh the complete workspace and trigger a second full rebuild manually.
+
−
# If still errors show up, please report this incident to the developer mailing list.
+
−
# Finally, ensure that the file /org.eclipse.recommenders.rcp.codecompletion.calls/data/models.zip actually exists in your workspace
+
−
 
+
−
Now you are ready to start a new Eclipse Runtime with Code Recommenders.
+

Latest revision as of 02:37, 26 September 2013

Get in Contact

Forum

Code Recommenders user forum is here: http://eclipse.org/forums/eclipse.recommenders. If you want to report an issue, request new features, or just get in contact with the development team, this is the preferred way.

Mailing List

Code Recommenders also maintains a developer mailing list. The recommenders-dev@eclipse.org list is used for announcements like committer election or notifying committers about build changes etc. Subscription is required to post messages to the list which can be done here: https://dev.eclipse.org/mailman/listinfo/recommenders-dev.


Reporting Bugs

Code Recommenders' Bugzilla is accessible via https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Recommenders


Contributing Patches

We welcome patches. We develop software transparently using Eclipse Gerrit. If you want to contribute a patch. simply submit it via Gerrit. If you have questions, how to set it up, check the Gerrit user guide or send an email to the recommenders-dev mailing list.

Retrieved from "https://wiki.eclipse.org/index.php?title=Recommenders/ContributorGuide&oldid=347928"

This page was last modified 02:37, 26 September 2013 by Eclipsepedia anonymous user Unnamed Poltroon.

Back to the top