Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EASE/Contributor Guide"
m |
|||
| Line 7: | Line 7: | ||
When you want to work on the source code you should start with the latest version of Eclipse for RCP and RAP develpopers. Start up with a fresh workspace and download the Tycho extensions. | When you want to work on the source code you should start with the latest version of Eclipse for RCP and RAP develpopers. Start up with a fresh workspace and download the Tycho extensions. | ||
| − | Our preferred way of receiving contributions is via Gerrit. So clone our core repository org.eclipse.ease.core (check the link for clone options). If you want to upload your changes, make sure you use the | + | Our preferred way of receiving contributions is via Gerrit. So clone our core repository org.eclipse.ease.core ([https://git.eclipse.org/r/#/admin/projects/ease/org.eclipse.ease.core check the link] for clone options). If you want to upload your changes, make sure you use the http option and use your eclipse account data. |
| − | + | We have 2 additional repositories: | |
| − | + | * [https://git.eclipse.org/r/#/admin/projects/ease/org.eclipse.ease.modules org.eclipse.ease.modules] for additional script modules | |
| − | + | * [https://git.eclipse.org/r/#/admin/projects/ease/org.eclipse.ease.scripts org.eclipse.ease.scripts] for useful sample scripts in various script languages | |
| − | For detailed instructions on how to contribute with gerrit, please read | + | After importing all projects in your workspace, set the target platform located at: [http://git.eclipse.org/c/ease/org.eclipse.ease.core.git/tree/releng/org.eclipse.ease.releng.target/org.eclipse.ease.releng.target.target org.eclipse.ease.releng.target/org.eclipse.ease.releng.target.target]. |
| + | |||
| + | Before you commit changes please load our code formatter template: Preferences/Java/Code Style/Formatter, click import and load the file [http://git.eclipse.org/c/ease/org.eclipse.ease.core.git/tree/developers/formatter.xml developers/formatter.xml] | ||
| + | |||
| + | For detailed instructions on how to contribute with gerrit, please read [http://www.vogella.com/tutorials/Gerrit/article.html#gerritsetup_user this excellent tutorial] from Lars Vogel. | ||
=== Bug Reports === | === Bug Reports === | ||
Revision as of 02:30, 14 August 2014
Contents
EASE Contributor Guide
Contribution to an open source project is not only about coding. There are multiple other ways to help this project, which we will describe below.
Source Contributions
When you want to work on the source code you should start with the latest version of Eclipse for RCP and RAP develpopers. Start up with a fresh workspace and download the Tycho extensions.
Our preferred way of receiving contributions is via Gerrit. So clone our core repository org.eclipse.ease.core (check the link for clone options). If you want to upload your changes, make sure you use the http option and use your eclipse account data.
We have 2 additional repositories:
- org.eclipse.ease.modules for additional script modules
- org.eclipse.ease.scripts for useful sample scripts in various script languages
After importing all projects in your workspace, set the target platform located at: org.eclipse.ease.releng.target/org.eclipse.ease.releng.target.target.
Before you commit changes please load our code formatter template: Preferences/Java/Code Style/Formatter, click import and load the file developers/formatter.xml
For detailed instructions on how to contribute with gerrit, please read this excellent tutorial from Lars Vogel.
Bug Reports
Creating bug reports and feature requests is a valuable contribution to the project. Please be as precise as possible when describing your problem. When facing exceptions a stacktrace is a valuable piece of information. Starting eclipse with the -console command line parameter might reveal such information.
File your bugs under technology/EASE.
Help newcomers
Answering questions on the forums, mailing list and on stackoverflow encourage new users to work with EASE and eventually become contributors in the future. Be polie and help out wherever you can. Do not rely on committers to answer every question. Even if we try, we want to encourage our users to help each other.
Create UIs/Graphics
UI and icon design are important to attract users. Bad visuals might repel users without even exploring the great things you could do with EASE. We host a special project for icon ideas, templates and UI mockups. For mockups we prefer Wireframe Sketcher, but accept any other freely consumable format, too.
Promotion
Blog, write, chat about EASE and spread the word. Attracting new users and developers is crucial to build up a living community.