GSoC overview

(Required information)
Line 24: Line 24:
=== Required information ===
=== Required information ===
-
Make sure to follow the instruction on the official GSoC website about submitting your application (particularly note that the application goes to  ([http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2013/help_page#4._How_does_a_student_apply google], not to us). They also list the information that are necessary from google point's of view.
+
Make sure to follow the instruction on the official GSoC website about submitting your application (particularly note that the application goes to  [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2013/help_page#4._How_does_a_student_apply google], not to us). They also list the information that are necessary from google point's of view.
We would like to know at least the following:
We would like to know at least the following:

Revision as of 23:42, 12 March 2013

Contents

Google Summer of Code 2013

During the Google Summer of Code google will pay students to participate in open source projects - see the link for additional details. Your work will be released under an open source license, in case of STK that will be GPL 3.0. Make especially sure that you fulfill GSoC's eligibility criteria.

For the first time SuperTuxKart will try to participate, i.e. become a mentoring organisation. That means (if we get accepted) that students can work on SuperTuxKart and receive money for it. They will be mentored by one of our experienced developers, and get some good work experience to start their career. Note that while SuperTuxKart is a game appealing to younger audiences, the code base is rather complicated, and our suggested tasks will certainly challenge students.

Our list of ideas or suggestions is online. Be aware that this is just a list of suggestions, and that students are welcome to apply with their own ideas. However the number of experienced mentors is somewhat limited, and our list of ideas was chosen since those tasks would be most beneficial for the development of SuperTuxKart. If you apply with your own idea, please make sure to discuss this with us beforehand.

Sounds great - What should I do?

First of all make sure to have played STK, and have a look at our milestones page to see where we want to go. For any further steps you need at least some basic familiarity with SVN (if you don't have SVN experience, the Version Control with Subversion book is a good start).

Then download and compile STK, instructions for this can be found here. You can find guides for compiling from source on all major platforms on the same website.

Have a look at our coding style and study our code, best using the doxygen pages. Note that the online version is updated irregularly, so best create your own documentation (just start doxygen in the src directory). Even if you should have your own idea, please check out our idea list first.

Getting in touch

The core team typically communicates over IRC and mailing lists. On IRC, we can be found on channel #stk on freenode. We are typically most active on week days from approximately 16:00 to 22:00, GMT -5 time. It is recommended to drop by our channel and idle by to see how things work, and discuss your application. It is also recommended to subscribe to the supertuxkart-devel mailing list and to post a message introducing yourself and your project. Discussing the project with one of the core team members will significantly increase the changes of your application to be accepted.

Code and tickets

The main prerequisite for working on SuperTuxKart is good C++ knowledge. You will also want to get familiar with our bug tracker. You do need a sourceforge account in order to submit a ticket. For a successful proposal we expect you to supply at least one patch beforehand so that we can have a look at your coding and commenting style. Either pick one of the existing tickets, or create your own ticket. In any case, please discuss the ticket with us first, some tickets might sound very simple but could be a lot of work for a proper implementation. While STK's documentation is rather good and extensive, we always welcome patches to improve this, and fix coding style issues.

Required information

Make sure to follow the instruction on the official GSoC website about submitting your application (particularly note that the application goes to google, not to us). They also list the information that are necessary from google point's of view.

We would like to know at least the following: Applications should contain at least the following points of information :

Retrieved from "http://supertuxkart.sourceforge.net/GSoC_overview"

User Tools