GSOC

This page describes Moodle's involvement with Google in their Summer of Code program. (This page was moved from Student_projects).

Overview

Moodle has been involved in Google's Summer of Code program since 2006. This program pays students to work on open source software products for about three months (over the northern hemisphere summer), mentored by existing developers of those products. The work usually adds a new feature or a new module. The intention is that this new code improves the core software, as well as helping new programmers to become familiar with developing in an open source community.

Matching students and mentors

Mentors are regular Moodle developers who volunteer to help guide and support students in the program. They may suggest new projects on these pages or just make themselves available to mentor existing projects. The final decision on who can be a mentor is made by Martin Dougiamas. Successful mentoring is quite a commitment so this task should not be taken on lightly.

Students apply to projects via Google and are evaluated and selected by the full group of Moodle mentors.

Development process

Once students and mentors have been matched with projects within Moodle, our process runs something like this:

Create a specification in Moodle Docs: On the wiki page created for them students should start developing a detailed specification with feedback from mentors. The page should outline database table designs, the GUI (eg mock screenshots), the hows and whys etc. The document should be clear and logically organised.

Seek and absorb community feedback: Students should introduce the project in the appropriate forums on Using Moodle to help draw attention to it and to stimulate some discussion around their development. The more feedback we have the better, especially if it includes a wide variety of users (developers, teachers, students etc). Students should keep responding in those forums to build a dialogue with the community.

Evolve the specification: Students and mentors should use the feedback to evolve the specification into something that all users are happy with. Sometimes it's worth doing more research to find the "best" way to do something without adding Yet Another Option.

Set up tasks in the Moodle Tracker: Once the specification has settled down, it's time to start work. The mentor should create a new issue in the Moodle Tracker, and students should add sub-tasks in roughly chronological order for all the different parts of the project. This helps students keep track of where they are, but also allows the community to "watch you" develop and to help you where they can. Before CVS permission is granted, patches and code can be attached to the sub-tasks.

Develop in CVS and link to tracker: Once CVS permission is granted, students can develop their code in Moodle's CVS repository. Every commit will then be attached automatically to the tracker if it includes an issue number (eg MDL-7777). This process works best for contained projects like modules - for complicated patches it is often easier just to attach successive diffs directly to the tracker bugs.

Advertise milestones in the forums: Major milestones should be posted in the forums, to maintain community interest and draw in new testers and more feedback.

Finish off projects: Once the time is up, finished projects need to be assessed and uploaded to Google as per their instructions. Hopefully the code is also good enough to go into the next Moodle release too!

Documentation

GSOC

Contents

Overview

Matching students and mentors

Development process

2006

2007

2008

See also