Difference between revisions of "GMOD Membership"

From GMOD
Jump to: navigation, search
m (Commitment of Support)
m (Non-GMOD Software)
Line 67: Line 67:
 
The current developers should also be open to new developers from the GMOD community contributing code and other support to the new component.  This ''open development'' model contributes to the long-term viability of the open source model.
 
The current developers should also be open to new developers from the GMOD community contributing code and other support to the new component.  This ''open development'' model contributes to the long-term viability of the open source model.
  
== Non-GMOD Software ==
+
=== Non-GMOD Software ===
 +
 
 +
Being officially part of GMOD has several advantages:
 +
* It tells users that software meets the [[#Requirements|requirements listed above]].
 +
* The software gets equal billing with other [[GMOD Components]] on the GMOD web site.
 +
* The software will be included in GMOD [[Training and Outreach]] activities, possibly including coverage at [[GMOD Summer School|GMOD Summer Schools]].
 +
 
 +
However, a component does not to be officially part of GMOD to have a presence in GMOD.  Any software that is useful to the GMOD community can have a presence on this web site.  See [[:Category:External|External]] for a list of such software.  We are particularly interested in non-GMOD tools, such as [[Artemis]], that interoperate with GMOD components.

Revision as of 21:40, 3 February 2010

Under Construction

This page or section is under construction.

This page describes how users, developers, and software become a part of GMOD.

Users

To become a GMOD user, just download, install, and start using one or more GMOD Components. That's it. There is no mandatory registration process, and you don't have to meet any set of requirements. GMOD is open to everyone.

You are encouraged to sign up to the (low-volume) GMOD Announce mailing list, and to the mailing list(s) for the components that you use. You can also subscribe to the GMOD News RSS feed. These will help keep you up to date on both the project and the components you use.

Developers

Developers are users who also contribute code back to the project. In the early days of GMOD every user was also a developer. This is no longer true, but every user can still become a developer.

There are several ways to become a developer:

  • You can write fixes or additions to GMOD Components that you already use, and then send the code (or a link to it) to the [[GMOD Mailing Lists|mailing list(s)] for that component. If the update is widely usefule, the lead developer(s) for the component will then fold it in to the component and your fix will be included in the next release.
  • You can become a developer with commit privileges and directly submit your updates to the source code repository for that component. This is a good option if you contribute code frequently. To get commit privileges you need to ask one of the developers already working on the component.
  • Finally, you can become a developer by contributing a new component to GMOD. See Software below for how to do that.

Developers are also encouraged to sign up for the GMOD Developer mailing list (and maybe GMOD Architecture as well).

Software

New software components become a part of GMOD through a nomination and evaluation process.

Nomination

Software can be nominated by its developers, by GMOD users, or by GMOD staff. New components also arise from within the community. Schema, DIYA, and MAKER are all recent examples of software becoming a part of GMOD.

Please contact the GMOD Help Desk if you would like to nominate a new component. You can also nominate a component by posting to the GMOD Mailing Lists that are most relevant to the tool.

Evaluation

Nominated software is first evaluated by GMOD staff (currently the GMOD Project Coordinator and the GMOD Help Desk) to see if it meets basic requirements such as open source licensing and GMOD interoperability. We'll also confirm a good faith commitment of support on the part of the component's developers. GMOD community members are then asked for feedback on the other requirements such as meeting a common need and useful over time. Community members are picked based on a known interest in the area the new tool addresses. If appropriate, a whole mailing list will be asked to evaluate the software.

GMOD staff will then make a decision based on community input and any response from the developers. The decision may be to include the software, to not include the software, or to include the software after additions development or documentation is done.

Requirements

To become a part of the GMOD suite, software has to meet several requirements:

Meets a Common Need

First, the program must meet a common need in biological research. A tool that is only useful with organisms that are two-dimensional (think butterfly wings), is probably not a good match for GMOD. Tools must be useful across a wide range of biology, and meet a widespread need. Tools that support next generation sequencing, gene expression, phenotypes, or comparative genomics are good examples of broadly applicable tools.

Useful Over Time

GMOD Components should be applicable and useful for at least several years. For example, GMOD tends to avoid analysis tools because this area of bioinformatics is constantly changing. However, the need to connect different analysis tools into reusable pipelines (see Ergatis and Galaxy for examples), is a common and longstanding need that will outlive any particular too.

Configurable and Extensible

GMOD tools should be usable in a wide variety of situations. Different user environments will require different configurations of the software. GMOD components should make it easy for users to do this tailoring in configuration files - they should generally not have to change the source code itself to get what they want. Another (complementary) way to achieve this is to have an extensible architecture where computer-savvy users can write plugins/extensions for tasks such as input/output using custom/local data sources and formats.

Open Source License for All Users

New GMOD software must have an Open Source Initiative (OSI) approved license, and that license must be free to all users. The GMOD project is committed to open source principles.

Interoperable With Other GMOD Components

New GMOD software must be interoperable with other GMOD Components. Usually this means that the software can export and/or import GFF, or that it can connect to Chado.

Commitment of Support

The developers of the software must be willing to make a good faith commitment to support the new component for at least 2 years after joining GMOD. This commitment includes setting up email lists, responding to user questions, writing and maintaining documentation, and adding new features and bug fixes to the code.

The current developers should also be open to new developers from the GMOD community contributing code and other support to the new component. This open development model contributes to the long-term viability of the open source model.

Non-GMOD Software

Being officially part of GMOD has several advantages:

However, a component does not to be officially part of GMOD to have a presence in GMOD. Any software that is useful to the GMOD community can have a presence on this web site. See External for a list of such software. We are particularly interested in non-GMOD tools, such as Artemis, that interoperate with GMOD components.

Facts about "GMOD Membership"RDF feed
BioSchema +
ChadoSchema +