Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.84 KB
Raw

Contributing Guidelines

You have to follow two rules only when contributing:

  • Produce readable code
  • No Tests -> No Merge!

Development Environment Setup

If you plan to contribute a feature or bugfix to this project or just the want to have a closer look at the sources, the following steps describe the setup of the development environment.

  1. Start an Eclipse IDE that has the Plug-in Development Environment (PDE) installed. If you want to use a fresh Eclipse installation, you can download Eclipse Standard. It contains everything you need.

  2. Clone the git repository from https://github.com/fappel/xiliary.git

  3. The necessary projects are located at the root of the repository. Import all of them into your workspace.

  4. In the com.codeaffine.xiliary.releng project there are suitable Target Platform Definitions. Open one of them and select the 'Set as Target Platform' link.

Now you are ready to hack the sources. If you whish to verify the setup, you can run the test suites. There is a launch configurations to run them all: All Xiliary Tests

Xiliary uses Maven/Tycho to build, the parent pom can be found in com.codeaffine.xiliary.releng.

Project License: Eclipse Public License

By contributing code you automatically agree with the following points regarding licensing:

  • You will only Submit Contributions where You have authored 100% of the content.
  • You will only Submit Contributions to which You have the necessary rights. This means that if You are employed You have received the necessary permissions from Your employer to make the Contributions.
  • Whatever content You Contribute will be provided under the Project License.