Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 3.99 KB
Raw

Contributing to Corrosion

Reporting Issues

Issue reports and feature requests are always appreciated and are made in the Issues tab

Code for Corrosion

Clone to Eclipse IDE

Automatic Setup

The easiest way to get an IDE to work on Corrosion is to use the Oomph setup. If you use the Eclipse installer, have a look at this installation page. It will guide the installation and complete setup of a development environment for Corrosion.

If you already have an Eclipse installation, use the main menu entry File > Import ... and in the import wizard, select Oomph > Projects from Catalog. On the next wizard page select entry Eclipse Projects > Corrosion and follow the wizard until the IDE is set up for development on Corrosion.

Manual Setup

This option is for everyone who wants to set up an Eclipse instance manually, as an alternative to the automatic setup described above.

First, clone this repository to a local location of your choice.

For running Corrosion in a child Eclipse instance:

  • Use Eclipse for Eclipse Contributors or any version of the Eclipse IDE with the Eclipse Plug-in Development Environment plugins installed..
  • Import the following projects into the Eclipse IDE:
    • org.eclipse.corrosion
    • target-platform
    • org.eclipse.corrosion.tests
  • (Ignore the errors, they are about to go away with the next step)
  • Set the Target Platform
    • Open the target-platform/target-platform.target file with the Target Editor
    • Press the Refresh button and wait for completion
    • In the top right corner, press the Set as Active Target Platform button
  • Run the org.eclipse.corrosion project as an Eclipse Application (Right-click on project > Run As > Eclipse Application; or using the Launch Configuration dialog)

Building locally

Local build happens with a simple mvnw clean verify. Main build output is a p2 repository that you can find in repository/target/repository. You can use it to install and test the built artifacts in a working Eclipse IDE.
Depending on your OS, you may have to prefix the command with ./ .

Note that on Windows the command cannot be invoked from PowerShell, but only from CMD.

The repository also contains "External Tools" launch configurations (for *nix and Windows systems) to start the command from within the IDE. In Eclipse open the main menu entry Run > External Tools > External Tools Configurations ... to select and start the configuration matching your operating system.

Making Pull Requests

Before committing your change, consider adding an entry to the documentation/Changelog.md file if your change is a non-trivial user facing change.

To keep the commit history clean and navigable, PR are limited to a single commit. If your PR has multiple commits that all work together, they should be squashed into a single commit. If you believe that the different commits are too unrelated to be squashed together, then they should be put into multiple PRs to allow single feature PRs.

Corrosion is an Eclipse project and all contributors must do the following before having a pull request merged: