Sigmah wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.


# Introduction #

This page is targeting the potential student candidates to contribute on the Sigmah project as part of the Google Summer of Code 2016 programme.
It provides context about the Sigmah project and above all ideas for them to build their project from. Those ideas have been collected from Sigmah users working in humanitarian NGOs. They represent their short-term priorities for new features in their software.



# Sigmah project #
## The project and its current users ##
**[Sigmah](http://www.sigmah.org/) is open source software for the shared  management of international aid projects**.

Available in 3 langues (English, French, Spanish) version 2.1 is currently in adoption by 7 NGOs **like Handicap International, CARE Nederland or Luexmbourg Red Cross**.

Users in Haiti, France, Pakistan or Afghanistan report new needs of features frequently because project is still young, and the [roadmap](http://www.sigmah.org/issues/roadmap_page.php) of the project keeps growing.

To understand Sigmah in a minute, look at this less than 2 minutes video:
{{dailymotion>x34m1mq?medium}}

## Technical details ##
Sigmah software is developed in Java using GWT + ExtJS. Access to database is done with Hibernate. Sigmah application forge is available at https://github.com/sigmah-dev/sigmah. Sigmah application is a very large and rich application. A strong effort to learn how to work on it is absolutely necessary. Don't expect to be able to do anything meaningful before one month of full time work to get easy with all functional and technical concepts. But.. if you like big challenges, you'll definetly get a rewarding one with this application!


## Sigmah project and GSoC2016 ##
For Google Summer of Code 2016, Sigmah will be represented by  [Groupe URD](http://www.urd.org/), functional project leader which will play the role of organization administrator.


## Resources for new contributors ##
After having taken a look to potential projects you may have on Sigmah, if you want to know more, you can join the **#sigmah channel on irc.freenode.net** (people will be idling around mostly during French business hours). Or as many open-source project, you can use the following resources more or less in the given order:
  -   Take a look at the [Sigmah User Guide](http://www.sigmah.org/print/book/export/html/219) to have a better idea of what the software is about, and at the [demo](http://demo.sigmah.org/) to know how it looks like.
  -   Go through the [[contributorguide:contributorguide|Contributor Guide]] on the  wiki of the project to better understand how the project id technically set up, and how you can concretely work on it.
  -   Install your own development environment and download your copy of the source code by following [[contributorguide:building|this procedure]]  (on the Contributor Guide as well).
  -   If ready to dive, send an "hello world!" on [sigmah-dev mailing list](http://groups.google.com/group/sigmah-dev) to start collaborating with other developers !

# Project ideas #

This project ideas list is just given as a suggestion. As written in the introduction, those ideas do however represent the short-term priorities of real users working in humanitarian NGOs. When describing a project idea, a _User Priority_ is attributed to each feature request associated with it, to reflect its importance in the eyes of the users.

But user priority might not be GSoC volunteer priority... A new important feature requested urgently by some users may be felt as boring to develop by a GSoC volunteer. We just give those _User priority_ because we believe that an exciting thing about contributing to Sigmah is that you're helping real users to work more efficiently in their daily work at managing humanitarian projects, and knowing where your help would be the most appreciated by users might be useful.

As a consequence, if a student wants to write its own proposal by mixing some of those projects or taking some inspiration from the [[http://www.sigmah.org/issues/roadmap_page.php|roadmap of the project]]  , he's also welcomed to do so.

Finally, for each project idea, we provide a _Development Difficulty_ level to give an hint about how easy or challenging it would be to deal with this idea.

## Project idea 1: Full-featured calendars ##

_Project Difficulty:_ Medium

**Presentation**

Sigmah already offers calendars for its users. But those calendars lack some advanced features and a higher level of integration between them, and integration with external calendar tools to reveal their full potential. As an example, when we make a demonstration of Sigmah to new users, 2 out 3 ask us: "Does the calendar integrate with Outlook?".

More than a restrictive list of new features, this project idea reach to provide a richer calendar experience within Sigmah with a well-designed set of new functionalities. For example the exact way to provide the integration with Outlook is open to proposition to see which calendar should be exported: a new user calendar ? each individual project calendar ? And how then to limit the burden for the user to have too many calendars to export ? A good user experience is strongly expected and good propositions are more than welcome!

**Examples**

_User Prority:_ 1

  * [[http://www.sigmah.org/issues/view.php?id=521|#521 Aggregating linked projects calendars]]
  * [[http://www.sigmah.org/issues/view.php?id=522|#522 Aggregating sub-orgunits calendars]]
  * [[http://www.sigmah.org/issues/view.php?id=824|#824 Calendars export to other devices]]
  * [[http://www.sigmah.org/issues/view.php?id=117|#117 User aggregated calendar]]
  * [[http://www.sigmah.org/issues/view.php?id=78|#78 Add a project and annual view in the calendar]]
  * [[http://www.sigmah.org/issues/view.php?id=852|#852 Advanced calendar component]]

_User Prority:_ 2

  * [[http://www.sigmah.org/issues/view.php?id=508|#508 Merge "todo" and "pending" reminders]]
  * [[http://www.sigmah.org/issues/view.php?id=520|#520 New date field option: saved in calendar]]
  * [[http://www.sigmah.org/issues/view.php?id=534|#534 Field-linked reminders incentives]]


**Impact**

The impact of the implementation of this project idea will be a better time management for NGOs: less forgotten deadline, less uncertainty on some key dates, etc. 

**Knowledge prerequisite**

Java/GWT.



## Project idea 2: Easier project model management ##

_Project Difficulty:_ Medium


**Presentation**

Sigmah's most fundamental feature is the flexibility it gives to organization in the way they can configure it. With this flexibility provided through project models management, organizations are able to design their project information system by themselves, through a graphical interface they're able to use and not by configuration files which scare them in most of the case.

Sigmah flexibility is already provided a great service to its users, but it needs to be enhanced to reply to new needs expressed by users.

**Examples**

_User Prority:_ 1

  * [[http://www.sigmah.org/issues/view.php?id=853|#853 Project/orgunit model export/import through an XML format]]
  * [[http://www.sigmah.org/issues/view.php?id=514|#514 Hypertext link in field titles]]
  * [[http://www.sigmah.org/issues/view.php?id=276|#276 Add a "Groups" tab in project/orgunit model management]]
  * [[http://www.sigmah.org/issues/view.php?id=430|#430 Delete group of fields]]
  * [[http://www.sigmah.org/issues/view.php?id=511|#511 Category modification flexibility]]
  * [[http://www.sigmah.org/issues/view.php?id=854|#854 Docked toolbar for project/orgunit model fields table]]


_User Prority:_ 2

  * [[http://www.sigmah.org/issues/view.php?id=390|#390 Renaming project/orgunit default fields]]
  * [[http://www.sigmah.org/issues/view.php?id=537|#537 Fold by default option for groups]]
  * [[http://www.sigmah.org/issues/view.php?id=120|#120 Multilingual project, orgunit, report models & categorie]]
  * [[http://www.sigmah.org/issues/view.php?id=527|#527 Twin fields]]


**Impact**

By developing a project idea of that sort, the GSoC volunteer will contribute to allow new usages of Sigmah by its users. It will help Sigmah adoption in wider parts of organization already adopting it.

**Knowledge prerequisite**

Java/GWT.



## Project idea 3: Search ##

_Project Difficulty:_ Hard

_Difficulty comment_: Hard project idea for the full-text search engine (which is only user priority 2) becauxe it will require a knowledge of Apache Solr and strong capability to integrate with Sigmah. And this work with Apache Solr to produce a rich search engine has been estimated to a total of 74 man-days of work by experienced Sigmah developers: those 74 days might be reduced if we reduce the expectation of the full-text search engine, so it can fit in 12 weeks (60 man-days) time period of a summer of code.


**Presentation**

Currently, Sigmah offers almost no way to search among projects. Two features have been requested by users to improve Sigmah search capabilities (see examples below). And more can be imagined!



**Examples**


_User Prority:_ 1

  * [[http://www.sigmah.org/issues/view.php?id=536|#536 Dashboard project table extra searchable columns]]


_User Prority:_ 2

  * [[http://www.sigmah.org/issues/view.php?id=535|#535 Full text search engine]]


**Impact**

Improved search capabilities would dramatically improved the user experience and the perceived interest to use Sigmah.


**Knowledge prerequisite**

Java/GWT, and Apache Solr for user priority 2 full text search engine.
Sigmah wiki

User Tools

Site Tools

Page Tools
