Skip to content
This repository has been archived by the owner on Sep 24, 2019. It is now read-only.

Developers

Nick Bargnesi edited this page Jul 31, 2012 · 6 revisions

This page is intended for developers of the BEL Editor.

Quick Start

  1. Fork the BEL Editor

  2. Clone the fork

    git clone ...

  3. Checkout the unstable branch

    git checkout unstable

  4. Add the main repository

    git remote add main_repo [email protected]:OpenBEL/bel-editor.git

  5. Push to the main repository when you have changes

    git push main_repo unstable

GitHub

The BEL Editor is hosted on GitHub. The main repository consists of two branches, stable and unstable. The two branches mirror the stable and unstable Eclipse repositories. The stable branch contains the latest stable release of the BEL Editor, suitable for daily use. The unstable branch contains experimental code that is only suitable for testing and experimenting with new features.

Forks

Developers should work in forks of the main repository.

  • Any branching strategy is fine for a fork.

    Examples: (1) using feature branches, (2) bug branches, and (3) using the unstable branch

  • New code should be merged into the unstable branch of your fork.

  • If a feature or bug is suitable for testing, push the fork's unstable branch to the main repository.

  • The stable branch in the main repository is only ever updated with code merged from unstable.

Issue Tracking

Issue tracking is done through our GitHub issue tracker.

Automation

The BEL Editor is built automatically when the main repository is pushed to. An instance of Atlassian Bamboo manages all builds of OpenBEL software. Deployments of the BEL Editor to the Eclipse repositories are also managed by Bamboo.

Source Tree

The BEL Editor consists primarily of two plugins:

  1. org.openbel.editor.core: Parts of the BEL language, parsing, and organizing projects.

  2. org.openbel.editor.ui: User interface components for editing BEL and organizing projects.

The local-repo script allows you to host a local P2 repository to install the development version (the current working tree) into Eclipse.

JRebel

Committers to the BEL Editor are eligible for a license of JRebel which is well-suited for developing Eclipse plugins.

Getting Started with JRebel

TODO