Developing with the OPF

Version 20 by David Tarrant
on Apr 18, 2012 16:23.

<< Changes from 19 to 20

compared with

Version 21 by Carl Wilson
on Mar 04, 2013 19:51.

Changes from 21 to 22 >>

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (5)

View Page History

h2. Overview

One of the main goals of the Open Planets Foundation is to <b>SUPPORT</b> *SUPPORT* the development of maintainable of maintainable "turn-key" digital preservation software.

To this extent we recommend that a simplistic well utilised strategy be employed when developing software, keeping use of many disparate services to a minimum where possible. 

The Open Planets Foundation recommends using GitHub to manage source code control and to provide the following features:

The OPF recommends using GitHub to manage source code and revision control, please read the [OPF's GitHub Guide|GitHub Guide].

* To put the software description and README
* To manage your source code

...

* To manage a roadmap via the issue tracker

Further to this the Open Planets Foundation main website has a series of software pages that are automatically populated from content in github, GitHub, so <b>you</b> *you* are in control of your piece of software. 

To find out more about getting your piece of software published via the Open Planets Foundation website, please read the [Software Development Guidelines]

...

h2. Sign-Up With OPF Labs

To add information to the wiki or to our issue tracker, you need an OPF Labs account. To develop with the OPF, you need to set up two accounts, one for github and one for the OPF Labs site.

* To join github, sign-up here: [https://github.com/signup/free|https://github.com/signup/free]
* To join OPF Labs, sign-up here: [http://jira.opf-labs.org/secure/Signup...|http://jira.opf-labs.org/secure/Signup\!default.jspa]
* After you've done this, let web-admin ( a t ) openplanetsfoundation.org know your username(s), and he will add you to the appropriate groups so that you have the permissions you need.

h2. OPF Labs Resources

The OPF development environment consists of:

* Code repositories on github: [https://github.com/openplanets]\*\* The Planets code will be archived on [SourceForge|http://sourceforge.net/projects/planets-suite/], but this is a 'backup' and not the development environment.
* OPF Labs development infrastructure:
** The wikis: [http://wiki.opf-labs.org/]
** Continuous build integration with Bamboo: [http://bamboo.opf-labs.org/][http://bamboo.opf-labs.org/]
** FishEye code inspection and review: {color:#006daf}\[{color}{color:#006daf}[http://fisheye.opf-labs.org/]{color}\|http://fisheye.opf-labs.org/\]

* Mailing lists and downloads are hosted in a number of places.
** e.g. Planets developers should join [https://lists.sourceforge.net/lists/listinfo/planets-suite-developers|https://lists.sourceforge.net/lists/listinfo/planets-suite-developers]

h2. Setting up git

* GitHub have this set-up help: [http://help.github.com/set-up-git-redirect]\*\* e.g. for Windows: [http://help.github.com/win-set-up-git/]

h3. Further help

* For help setting up git and github, see [http://help.github.com/]\*\* see also this nice HTML5 git cheatsheet [http://www.ndpsoftware.com/git-cheatsheet.html]
* If you use Eclipse, the egit plugin is pretty good: [http://www.eclipse.org/egit/]\*\* Here's a tutorial on how to use it: [http://www.vogella.de/articles/EGit/article.html]
* If you use Windows, the tortoisegit shell integration is quite good: [http://code.google.com/p/tortoisegit/]
* [OPF Labs front page|KB:Home]
* [Planets Suite Wiki|PT:Planets Suite Components]