Actions

GSoC getting started: Difference between revisions

From LimeSurvey Manual

No edit summary
No edit summary
Line 2: Line 2:
__TOC__
__TOC__


=Getting Started with LimeSurvey and Google's Summer of Code=
This page was created for GSoC applicants to give them all the information they need to get familiar with Limesurvey and create a successful application for the GSoC program.


==The LimeSurvey Development Environment==
=Accounts=


LimeSurvey Version 2 uses:
The most important links first:
*Create a personal account on the limesurvey.org website here (if you don't have one): [http://www.limesurvey.org/en/component/comprofiler/registers Click here].
*Create a personal account on sourceforge.net here (if you don't have one): [https://sourceforge.net/account/registration/ Click here].
*Make sure you subscribe to the [https://sourceforge.net/mail/?group_id=74605 limesurvey-developer mailing list]. If you want to get notified of any changes in the development source code then subscribe to the limesurvey-csv list too.
*If you use a Windows System get the Subversion client TortoiseSVN to access the source code in the repository on sf.net. You can download it from [http://tortoisesvn.sourceforge.net/downloads here].
 
=The LimeSurvey Development Environment=
 
Coding skills:
* [http://www.php.net/ PHP] 5 and up
* [http://www.php.net/ PHP] 5 and up
* [http://cakephp.org/ CakePHP] 1.2 Beta Framework w/ [http://code.google.com/p/cakephp-migrations/ CakeMigrations]
* [http://www.jquery.org/ jQuery]
* [http://www.jquery.org/ jQuery]
* and the usual HTML/CSS


=Student Guidelines=
Coding Guidelines:
 
==General==
#Create a personal account on the limesurvey.org website here (if you don't have one): [http://www.limesurvey.org/en/component/comprofiler/registers Click here].
#Create a personal account on sourceforge.net here (if you don't have one): [https://sourceforge.net/account/registration/ Click here].
#Make sure you subscribe to the [https://sourceforge.net/mail/?group_id=74605 limesurvey-developer mailing list]. If you want to get notified of any changes in the development source code then subscribe to the limesurvey-csv list too.
#If you use a Windows System get the Subversion client TortoiseSVN to access the source code in the repository on sf.net. You can download it from [http://tortoisesvn.sourceforge.net/downloads here].
 
==LimeSurvey 2.0 Development==
* [http://docs.limesurvey.org/tiki-index.php?page=Development General Development Guidelines Page]
* [http://docs.limesurvey.org/tiki-index.php?page=Development General Development Guidelines Page]


==Configure and Setup LimeSurvey 2==
=Get in touch with Limesurvey=
*  [http://docs.limesurvey.org/tiki-index.php?page=LimeSurvey+2.0+Development+Setup Limesurvey 2 Development Setup]


==Expectations==
==Show us you can work on LimeSurvey==
*  Students are expected to participate widely and fully in the LimeSurvey development community. They are expected to crack at least one joke during the weekly developers meeting. They are expected to have fun and to look for original and unique ways of improving the software. Most importantly, communicate communicate communicate.


===Coding Standards===
We don't want students to simply send their applications without talking to us or getting in touch with the community beforehand. We want to see some action up front and there are several ways to show your passion for Limesurvey.
*  [http://docs.limesurvey.org/tiki-index.php?page=Coding+Rules LimeSurvey 2.0 Coding Rules]


===Communication===
===Fix Bugs===
*  Communication is to be carried out by all means possible. Email and IM communication with your mentor would be a primary method. The IRC channel, and website forums are an alternative way.


===Documentation===
Fix bugs and perform other tasks that makes you a strong contender for being selected as a GSoC student. We have add a "GSoC" prefix to some simple bugs at [http://bugs.limesurvey.org/ our bugtracker]. Fixing bugs is a good way to get familiar with the code and see how things work together. If you have problems fixing a bug or you need a first start, don't hesitate to contact us!
* Documentation is hugely important to our user base, and it is the most difficult to build and maintain. New features need good documentation, but bad documentation is better than none and provides a starting point for future improvement. Continuous improvement is the idea. Students are expected to document their projects and new features.


==Show us you can work on LimeSurvey 2==
===Implement New Features===


Fix bugs and perform other tasks that makes you a strong contender for being selected as a GSoC student (not mandatory).
At [http://ideas.limesurvey.org/ our idea tracker] there are several great ideas submitted by our users which means that they are eagerly waiting for ''you ''to [http://docs.limesurvey.org/How+to+contribute+new+features implement them]. Don't start with rewriting the survey engine, start with simple tasks and get in touch with us before starting to implement minor improvements.


===Additional information for student developers===
===Help Our Users===


With the new LimeSurvey 2.0 code we strictly pay attention to coding guidelines which are very important.
Helping others to use our software is a great way to share your knowledge and learn about problems and solutions yourself. Hang around at [http://www.limesurvey.org/en/support/live-chat our IRC] or check [http://www.limesurvey.org/en/forum the forums] and offer your help.


Coding Guidelines and  Generic Code Implementation will help you and any developers working on your code at a later time by easier understanding your code and making it more modular.
==Communication & Expectations==
 
*  Communication is to be carried out by all means possible. Email and IM communication with your mentor would be a primary method. The [http://www.limesurvey.org/en/support/live-chat IRC channel], and [http://www.limesurvey.org/en/forum website forums] are an alternative way.
To ensure this quality we are mentoring student developers using the following steps:
*  Students are expected to participate widely and fully in the LimeSurvey development community. They are expected to crack at least one joke during the weekly developers meeting. They are expected to have fun and to look for original and unique ways of improving the software. Most importantly, communicate communicate communicate.
# The student developer needs to choose a task from the bug tracker.
# The developer sends the code to the mentor for review.
# If the mentor is satisfied with the code quality the developer is now ready to work on his idea with LimeSurvey.
# Rinse and repeat Step 1 to 3 until the mentor states that the developer is ready to submit patches freely to the repository.


==LimeSurvey Bug Tracker==
==LimeSurvey Bug Tracker==

Revision as of 03:02, 9 February 2011

This page was created for GSoC applicants to give them all the information they need to get familiar with Limesurvey and create a successful application for the GSoC program.

Accounts

The most important links first:

  • Create a personal account on the limesurvey.org website here (if you don't have one): Click here.
  • Create a personal account on sourceforge.net here (if you don't have one): Click here.
  • Make sure you subscribe to the limesurvey-developer mailing list. If you want to get notified of any changes in the development source code then subscribe to the limesurvey-csv list too.
  • If you use a Windows System get the Subversion client TortoiseSVN to access the source code in the repository on sf.net. You can download it from here.

The LimeSurvey Development Environment

Coding skills:

Coding Guidelines:

Get in touch with Limesurvey

Show us you can work on LimeSurvey

We don't want students to simply send their applications without talking to us or getting in touch with the community beforehand. We want to see some action up front and there are several ways to show your passion for Limesurvey.

Fix Bugs

Fix bugs and perform other tasks that makes you a strong contender for being selected as a GSoC student. We have add a "GSoC" prefix to some simple bugs at our bugtracker. Fixing bugs is a good way to get familiar with the code and see how things work together. If you have problems fixing a bug or you need a first start, don't hesitate to contact us!

Implement New Features

At our idea tracker there are several great ideas submitted by our users which means that they are eagerly waiting for you to implement them. Don't start with rewriting the survey engine, start with simple tasks and get in touch with us before starting to implement minor improvements.

Help Our Users

Helping others to use our software is a great way to share your knowledge and learn about problems and solutions yourself. Hang around at our IRC or check the forums and offer your help.

Communication & Expectations

  •  Communication is to be carried out by all means possible. Email and IM communication with your mentor would be a primary method. The IRC channel, and website forums are an alternative way.
  •  Students are expected to participate widely and fully in the LimeSurvey development community. They are expected to crack at least one joke during the weekly developers meeting. They are expected to have fun and to look for original and unique ways of improving the software. Most importantly, communicate communicate communicate.

LimeSurvey Bug Tracker

Visit http://bugs.limesurvey.org/ for our bugtracker!

How to apply

A very important step indeed, if you want to be selected as GSoC student for LimeSurvey. Pretty obviously, if you don't want to apply we won't be able to help you with GSoC. But if you do, we are always there (:biggrin:)!!

Follow the instructions below:

  • Setup LimeSurvey 2 Development Environment and play with it. It will be great if you setup a small survey and ask your friends to take it. We are sure you will love it!!
  • By this time you will have some working idea about LimeSurvey, you will surely like some features and find some features lacking in LimeSurvey. Yeah! its just the right time to visit the ideas page and look for the ideas you found lacking. If you dont find your ideas there, discuss on the mailing list, LimeSurvey forums or at #limesurvey on Freenode.
  • Now contact potential mentors, discuss the idea and prepare your application. See how to write your application.
  • Check our Selection Criteria.
  • Edit your application if you think it requires some changes after reading our Selection Criteria. Ask your any mentor to review the application and then make the changes as suggested.
  • Submit your applications via the Google Summer of Code 2009 site from March 23 - April 3, 2009.

That's it you're done! Google will announce the list of accepted students for LimeSurvey at Google Summer of Code 2009 Site on April 20:19:00 UTC.

No need for you to wait till then. You can start contributing right away! Fix bugs and show us you are the right person deserving to be a GSoC student for LimeSurvey.Good Luck!!

Getting Help

  1. Visit the official Lime Survey IRC Channel and SAY HELLO TO US!
    ([1])
  2. Ask for help. We are good guys and want you to have fun all summer while being with LimeSurvey. So, don't hesitate at anything that's troubling or bothering you.

More Information

LimeSurvey Google Summer of Code 2009

An introduction to LimeSurvey and our application for this years Google Summer of Code

Project Ideas Page

The LimeSurvey Community Ideas Page:

- ideas that the community have come up with and would love to help you create

Frequently Asked Questions